New upstream version 1.12.208+repack
This commit is contained in:
TANIGUCHI Takaki
parent
ec7ff4b8b5
commit
18782f0ac3
2
PKG-INFO
2
PKG-INFO
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 1.12.200
|
||||
Version: 1.12.208
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Amazon Web Services
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 1.12.200
|
||||
Version: 1.12.208
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Amazon Web Services
|
||||
|
|
|
|||
|
|
@ -402,6 +402,8 @@ botocore/data/kinesisvideo/2017-09-30/service-2.json
|
|||
botocore/data/kms/2014-11-01/examples-1.json
|
||||
botocore/data/kms/2014-11-01/paginators-1.json
|
||||
botocore/data/kms/2014-11-01/service-2.json
|
||||
botocore/data/lakeformation/2017-03-31/paginators-1.json
|
||||
botocore/data/lakeformation/2017-03-31/service-2.json
|
||||
botocore/data/lambda/2014-11-11/service-2.json
|
||||
botocore/data/lambda/2015-03-31/examples-1.json
|
||||
botocore/data/lambda/2015-03-31/paginators-1.json
|
||||
|
|
@ -1080,6 +1082,7 @@ tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.sts
|
|||
tests/unit/cfg/aws_bad_profile
|
||||
tests/unit/cfg/aws_config
|
||||
tests/unit/cfg/aws_config_bad
|
||||
tests/unit/cfg/aws_config_badbytes
|
||||
tests/unit/cfg/aws_config_nested
|
||||
tests/unit/cfg/aws_config_nested_bad
|
||||
tests/unit/cfg/aws_config_nocreds
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ import os
|
|||
import re
|
||||
import logging
|
||||
|
||||
__version__ = '1.12.200'
|
||||
__version__ = '1.12.208'
|
||||
|
||||
|
||||
class NullHandler(logging.Handler):
|
||||
|
|
|
|||
|
|
@ -147,7 +147,7 @@ def raw_config_parse(config_filename, parse_subsections=True):
|
|||
cp = six.moves.configparser.RawConfigParser()
|
||||
try:
|
||||
cp.read([path])
|
||||
except six.moves.configparser.Error:
|
||||
except (six.moves.configparser.Error, UnicodeDecodeError):
|
||||
raise botocore.exceptions.ConfigParseError(
|
||||
path=_unicode_path(path))
|
||||
else:
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the specified Application Auto Scaling scaling policy.</p> <p>Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>"
|
||||
"documentation":"<p>Deletes the specified scaling policy for an Application Auto Scaling scalable target.</p> <p>Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#delete-step-scaling-policy\">Delete a Step Scaling Policy</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html#delete-target-tracking-policy\">Delete a Target Tracking Scaling Policy</a> in the <i>Application Auto Scaling User Guide</i>.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>"
|
||||
},
|
||||
"DeleteScheduledAction":{
|
||||
"name":"DeleteScheduledAction",
|
||||
|
|
@ -43,7 +43,7 @@
|
|||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the specified Application Auto Scaling scheduled action.</p>"
|
||||
"documentation":"<p>Deletes the specified scheduled action for an Application Auto Scaling scalable target.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html#delete-scheduled-action\">Delete a Scheduled Action</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"DeregisterScalableTarget":{
|
||||
"name":"DeregisterScalableTarget",
|
||||
|
|
@ -59,7 +59,7 @@
|
|||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Deregisters a scalable target.</p> <p>Deregistering a scalable target deletes the scaling policies that are associated with it.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. </p>"
|
||||
"documentation":"<p>Deregisters an Application Auto Scaling scalable target.</p> <p>Deregistering a scalable target deletes the scaling policies that are associated with it.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. </p>"
|
||||
},
|
||||
"DescribeScalableTargets":{
|
||||
"name":"DescribeScalableTargets",
|
||||
|
|
@ -75,7 +75,7 @@
|
|||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Gets information about the scalable targets in the specified namespace.</p> <p>You can filter the results using the <code>ResourceIds</code> and <code>ScalableDimension</code> parameters.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. If you are no longer using a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
|
||||
"documentation":"<p>Gets information about the scalable targets in the specified namespace.</p> <p>You can filter the results using <code>ResourceIds</code> and <code>ScalableDimension</code>.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. If you are no longer using a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
|
||||
},
|
||||
"DescribeScalingActivities":{
|
||||
"name":"DescribeScalingActivities",
|
||||
|
|
@ -91,7 +91,7 @@
|
|||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.</p> <p>You can filter the results using the <code>ResourceId</code> and <code>ScalableDimension</code> parameters.</p> <p>Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see <a>DescribeScalingPolicies</a>. To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>"
|
||||
"documentation":"<p>Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.</p> <p>You can filter the results using <code>ResourceId</code> and <code>ScalableDimension</code>.</p> <p>Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see <a>DescribeScalingPolicies</a>. To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>"
|
||||
},
|
||||
"DescribeScalingPolicies":{
|
||||
"name":"DescribeScalingPolicies",
|
||||
|
|
@ -108,7 +108,7 @@
|
|||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Describes the scaling policies for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>PolicyNames</code> parameters.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>"
|
||||
"documentation":"<p>Describes the Application Auto Scaling scaling policies for the specified service namespace.</p> <p>You can filter the results using <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>PolicyNames</code>.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>"
|
||||
},
|
||||
"DescribeScheduledActions":{
|
||||
"name":"DescribeScheduledActions",
|
||||
|
|
@ -124,7 +124,7 @@
|
|||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Describes the scheduled actions for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>ScheduledActionNames</code> parameters.</p> <p>To create a scheduled action or update an existing one, see <a>PutScheduledAction</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p>"
|
||||
"documentation":"<p>Describes the Application Auto Scaling scheduled actions for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>ScheduledActionNames</code> parameters.</p> <p>To create a scheduled action or update an existing one, see <a>PutScheduledAction</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p>"
|
||||
},
|
||||
"PutScalingPolicy":{
|
||||
"name":"PutScalingPolicy",
|
||||
|
|
@ -175,7 +175,7 @@
|
|||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Each scalable target has a resource ID, scalable dimension, and namespace, as well as values for minimum and maximum capacity. </p> <p>After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use <a>DescribeScalableTargets</a>. You can also view the scaling policies for a service namespace using <a>DescribeScalableTargets</a>. </p> <p>If you no longer need a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
|
||||
"documentation":"<p>Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace. </p> <p>When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling will not scale capacity to values that are outside of this range. </p> <p>To update a scalable target, specify the parameter that you want to change as well as the following parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request. </p> <p>After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use <a>DescribeScalableTargets</a>. You can also view the scaling policies for a service namespace by using <a>DescribeScalableTargets</a>. </p> <p>If you no longer need a scalable target, you can deregister it by using <a>DeregisterScalableTarget</a>.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -264,15 +264,15 @@
|
|||
},
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -292,7 +292,7 @@
|
|||
"members":{
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ScheduledActionName":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
|
|
@ -300,11 +300,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -323,15 +323,15 @@
|
|||
"members":{
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -346,15 +346,15 @@
|
|||
"members":{
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceIds":{
|
||||
"shape":"ResourceIdsMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -385,15 +385,15 @@
|
|||
"members":{
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -428,15 +428,15 @@
|
|||
},
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -471,15 +471,15 @@
|
|||
},
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -629,11 +629,11 @@
|
|||
"members":{
|
||||
"PredefinedMetricType":{
|
||||
"shape":"MetricType",
|
||||
"documentation":"<p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to Spot fleet requests and ECS services.</p>"
|
||||
"documentation":"<p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to Spot Fleet requests and ECS services.</p>"
|
||||
},
|
||||
"ResourceLabel":{
|
||||
"shape":"ResourceLabel",
|
||||
"documentation":"<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group attached to the Spot fleet request or ECS service.</p> <p>The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:</p> <ul> <li> <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.</p> </li> </ul>"
|
||||
"documentation":"<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group attached to the Spot Fleet request or ECS service.</p> <p>The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:</p> <ul> <li> <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.</p>"
|
||||
|
|
@ -653,19 +653,19 @@
|
|||
},
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"PolicyType":{
|
||||
"shape":"PolicyType",
|
||||
"documentation":"<p>The policy type. This parameter is required if you are creating a scaling policy.</p> <p>For information on which services do not support <code>StepScaling</code> or <code>TargetTrackingScaling</code>, see the information about <b>Limits</b> in <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html\">Step Scaling Policies</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html\">Target Tracking Scaling Policies</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The policy type. This parameter is required if you are creating a scaling policy.</p> <p>The following policy types are supported: </p> <p> <code>TargetTrackingScaling</code>—Not supported for Amazon EMR or AppStream</p> <p> <code>StepScaling</code>—Not supported for Amazon DynamoDB</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html\">Step Scaling Policies for Application Auto Scaling</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html\">Target Tracking Scaling Policies for Application Auto Scaling</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"StepScalingPolicyConfiguration":{
|
||||
"shape":"StepScalingPolicyConfiguration",
|
||||
|
|
@ -702,7 +702,7 @@
|
|||
"members":{
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"Schedule":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
|
|
@ -714,11 +714,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TimestampType",
|
||||
|
|
@ -749,27 +749,27 @@
|
|||
"members":{
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"MinCapacity":{
|
||||
"shape":"ResourceCapacity",
|
||||
"documentation":"<p>The minimum value to scale to in response to a scale-in event. This parameter is required to register a scalable target.</p>"
|
||||
"documentation":"<p>The minimum value to scale to in response to a scale-in event. <code>MinCapacity</code> is required to register a scalable target.</p>"
|
||||
},
|
||||
"MaxCapacity":{
|
||||
"shape":"ResourceCapacity",
|
||||
"documentation":"<p>The maximum value to scale to in response to a scale-out event. This parameter is required to register a scalable target.</p>"
|
||||
"documentation":"<p>The maximum value to scale to in response to a scale-out event. <code>MaxCapacity</code> is required to register a scalable target.</p>"
|
||||
},
|
||||
"RoleARN":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html\">Service-Linked Roles for Application Auto Scaling</a>.</p> <p>For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>"
|
||||
"documentation":"<p>Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html\">Service-Linked Roles for Application Auto Scaling</a>.</p> <p>For resources that are not supported using a service-linked role, this parameter is required, and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -828,15 +828,15 @@
|
|||
"members":{
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"MinCapacity":{
|
||||
"shape":"ResourceCapacity",
|
||||
|
|
@ -898,15 +898,15 @@
|
|||
},
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"XmlString",
|
||||
|
|
@ -977,15 +977,15 @@
|
|||
},
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"PolicyType":{
|
||||
"shape":"PolicyType",
|
||||
|
|
@ -1031,7 +1031,7 @@
|
|||
},
|
||||
"ServiceNamespace":{
|
||||
"shape":"ServiceNamespace",
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
},
|
||||
"Schedule":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
|
|
@ -1039,11 +1039,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TimestampType",
|
||||
|
|
@ -1115,7 +1115,7 @@
|
|||
"members":{
|
||||
"AdjustmentType":{
|
||||
"shape":"AdjustmentType",
|
||||
"documentation":"<p>The adjustment type, which specifies how the <code>ScalingAdjustment</code> parameter in a <a>StepAdjustment</a> is interpreted.</p>"
|
||||
"documentation":"<p>Specifies whether the <code>ScalingAdjustment</code> value in a <a>StepAdjustment</a> is an absolute number or a percentage of the current capacity. </p>"
|
||||
},
|
||||
"StepAdjustments":{
|
||||
"shape":"StepAdjustments",
|
||||
|
|
@ -1181,5 +1181,5 @@
|
|||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>With Application Auto Scaling, you can configure automatic scaling for your scalable resources. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS or custom resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>Schedule one-time or recurring scaling actions</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"https://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html\">Managing Throughput Capacity Automatically with DynamoDB Auto Scaling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> <li> <p>Amazon Aurora Replicas. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Integrating.AutoScaling.html\">Using Amazon Aurora Auto Scaling with Aurora Replicas</a>.</p> </li> <li> <p>Amazon SageMaker endpoint variants. For more information, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/endpoint-auto-scaling.html\">Automatically Scaling Amazon SageMaker Models</a>.</p> </li> <li> <p>Custom resources provided by your own applications or services. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>. </p> </li> </ul> <p>To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>"
|
||||
"documentation":"<p>With Application Auto Scaling, you can configure automatic scaling for the following resources:</p> <ul> <li> <p>Amazon ECS services</p> </li> <li> <p>Amazon EC2 Spot Fleet requests</p> </li> <li> <p>Amazon EMR clusters</p> </li> <li> <p>Amazon AppStream 2.0 fleets </p> </li> <li> <p>Amazon DynamoDB tables and global secondary indexes throughput capacity</p> </li> <li> <p>Amazon Aurora Replicas</p> </li> <li> <p>Amazon SageMaker endpoint variants</p> </li> <li> <p>Custom resources provided by your own applications or services</p> </li> </ul> <p> <b>API Summary</b> </p> <p>The Application Auto Scaling service API includes two key sets of actions: </p> <ul> <li> <p>Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.</p> </li> <li> <p>Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.</p> </li> </ul> <p>To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -226,6 +226,21 @@
|
|||
],
|
||||
"documentation":"<p>Lists the problems with your application.</p>"
|
||||
},
|
||||
"UpdateApplication":{
|
||||
"name":"UpdateApplication",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateApplicationRequest"},
|
||||
"output":{"shape":"UpdateApplicationResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Updates the application.</p>"
|
||||
},
|
||||
"UpdateComponent":{
|
||||
"name":"UpdateComponent",
|
||||
"http":{
|
||||
|
|
@ -297,9 +312,17 @@
|
|||
"shape":"LifeCycle",
|
||||
"documentation":"<p>The lifecycle of the application. </p>"
|
||||
},
|
||||
"OpsItemSNSTopicArn":{
|
||||
"shape":"OpsItemSNSTopicArn",
|
||||
"documentation":"<p> The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates. </p>"
|
||||
},
|
||||
"OpsCenterEnabled":{
|
||||
"shape":"OpsCenterEnabled",
|
||||
"documentation":"<p> Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application. </p>"
|
||||
},
|
||||
"Remarks":{
|
||||
"shape":"Remarks",
|
||||
"documentation":"<p>The issues on the user side that are blocking Application Insights from fully monitoring the application.</p>"
|
||||
"documentation":"<p>The issues on the user side that block Application Insights from successfully monitoring an application.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes the status of the application.</p>"
|
||||
|
|
@ -325,6 +348,14 @@
|
|||
"ResourceGroupName":{
|
||||
"shape":"ResourceGroupName",
|
||||
"documentation":"<p>The name of the resource group.</p>"
|
||||
},
|
||||
"OpsCenterEnabled":{
|
||||
"shape":"OpsCenterEnabled",
|
||||
"documentation":"<p> When set to <code>true</code>, creates opsItems for any problems detected on an application. </p>"
|
||||
},
|
||||
"OpsItemSNSTopicArn":{
|
||||
"shape":"OpsItemSNSTopicArn",
|
||||
"documentation":"<p> The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -438,7 +469,7 @@
|
|||
},
|
||||
"Tier":{
|
||||
"shape":"Tier",
|
||||
"documentation":"<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB_TIER</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code>.</p>"
|
||||
"documentation":"<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -477,7 +508,7 @@
|
|||
},
|
||||
"Tier":{
|
||||
"shape":"Tier",
|
||||
"documentation":"<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB_TIER</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code> </p>"
|
||||
"documentation":"<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code> </p>"
|
||||
},
|
||||
"ComponentConfiguration":{
|
||||
"shape":"ComponentConfiguration",
|
||||
|
|
@ -777,6 +808,8 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Observation"}
|
||||
},
|
||||
"OpsCenterEnabled":{"type":"boolean"},
|
||||
"OpsItemSNSTopicArn":{"type":"string"},
|
||||
"PaginationToken":{"type":"string"},
|
||||
"Problem":{
|
||||
"type":"structure",
|
||||
|
|
@ -840,6 +873,7 @@
|
|||
"documentation":"<p>Describes observations related to the problem.</p>"
|
||||
},
|
||||
"Remarks":{"type":"string"},
|
||||
"RemoveSNSTopic":{"type":"boolean"},
|
||||
"ResourceARN":{"type":"string"},
|
||||
"ResourceGroupName":{"type":"string"},
|
||||
"ResourceInUseException":{
|
||||
|
|
@ -885,6 +919,37 @@
|
|||
"Tier":{"type":"string"},
|
||||
"Title":{"type":"string"},
|
||||
"Unit":{"type":"string"},
|
||||
"UpdateApplicationRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceGroupName"],
|
||||
"members":{
|
||||
"ResourceGroupName":{
|
||||
"shape":"ResourceGroupName",
|
||||
"documentation":"<p>The name of the resource group.</p>"
|
||||
},
|
||||
"OpsCenterEnabled":{
|
||||
"shape":"OpsCenterEnabled",
|
||||
"documentation":"<p> When set to <code>true</code>, creates opsItems for any problems detected on an application. </p>"
|
||||
},
|
||||
"OpsItemSNSTopicArn":{
|
||||
"shape":"OpsItemSNSTopicArn",
|
||||
"documentation":"<p> The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.</p>"
|
||||
},
|
||||
"RemoveSNSTopic":{
|
||||
"shape":"RemoveSNSTopic",
|
||||
"documentation":"<p> Disassociates the SNS topic from the opsItem created for detected problems.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateApplicationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ApplicationInfo":{
|
||||
"shape":"ApplicationInfo",
|
||||
"documentation":"<p>Information about the application. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateComponentConfigurationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -906,7 +971,7 @@
|
|||
},
|
||||
"Tier":{
|
||||
"shape":"Tier",
|
||||
"documentation":"<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB_TIER</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code>.</p>"
|
||||
"documentation":"<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code>.</p>"
|
||||
},
|
||||
"ComponentConfiguration":{
|
||||
"shape":"ComponentConfiguration",
|
||||
|
|
|
|||
|
|
@ -2009,6 +2009,10 @@
|
|||
"cloudWatchLogsRoleArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account. </p>"
|
||||
},
|
||||
"excludeVerboseContent":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The CloudWatch Logs configuration.</p>"
|
||||
|
|
|
|||
|
|
@ -667,7 +667,7 @@
|
|||
{"shape":"LimitExceededFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling group.</p> <p>A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using <a>RecordLifecycleActionHeartbeat</a>.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action using <a>CompleteLifecycleAction</a>.</p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.</p> <p>You can view the lifecycle hooks for an Auto Scaling group using <a>DescribeLifecycleHooks</a>. If you are no longer using a lifecycle hook, you can delete it using <a>DeleteLifecycleHook</a>.</p>"
|
||||
"documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling group.</p> <p>A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using <a>RecordLifecycleActionHeartbeat</a>.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action using <a>CompleteLifecycleAction</a>.</p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.</p> <p>You can view the lifecycle hooks for an Auto Scaling group using <a>DescribeLifecycleHooks</a>. If you are no longer using a lifecycle hook, you can delete it using <a>DeleteLifecycleHook</a>.</p>"
|
||||
},
|
||||
"PutNotificationConfiguration":{
|
||||
"name":"PutNotificationConfiguration",
|
||||
|
|
@ -699,7 +699,7 @@
|
|||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
],
|
||||
"documentation":"<p>Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.</p>"
|
||||
"documentation":"<p>Creates or updates a scaling policy for an Auto Scaling group. To update an existing scaling policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.</p> <p>For more information about using scaling policies to scale your Auto Scaling group automatically, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"PutScheduledUpdateGroupAction":{
|
||||
"name":"PutScheduledUpdateGroupAction",
|
||||
|
|
@ -828,7 +828,7 @@
|
|||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
],
|
||||
"documentation":"<p>Updates the configuration for the specified Auto Scaling group.</p> <p>To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.</p> <p>If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration, but existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.</p> <p>Note the following about changing <code>DesiredCapacity</code>, <code>MaxSize</code>, or <code>MinSize</code>:</p> <ul> <li> <p>If a scale-in event occurs as a result of a new <code>DesiredCapacity</code> value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.</p> </li> <li> <p>If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, this sets the group's <code>DesiredCapacity</code> to the new <code>MinSize</code> value.</p> </li> <li> <p>If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, this sets the group's <code>DesiredCapacity</code> to the new <code>MaxSize</code> value.</p> </li> </ul> <p>To see which parameters have been set, use <a>DescribeAutoScalingGroups</a>. You can also view the scaling policies for an Auto Scaling group using <a>DescribePolicies</a>. If the group has scaling policies, you can update them using <a>PutScalingPolicy</a>.</p>"
|
||||
"documentation":"<p>Updates the configuration for the specified Auto Scaling group.</p> <p>To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.</p> <p>If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.</p> <p>Note the following about changing <code>DesiredCapacity</code>, <code>MaxSize</code>, or <code>MinSize</code>:</p> <ul> <li> <p>If a scale-in event occurs as a result of a new <code>DesiredCapacity</code> value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.</p> </li> <li> <p>If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, this sets the group's <code>DesiredCapacity</code> to the new <code>MinSize</code> value.</p> </li> <li> <p>If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, this sets the group's <code>DesiredCapacity</code> to the new <code>MaxSize</code> value.</p> </li> </ul> <p>To see which parameters have been set, use <a>DescribeAutoScalingGroups</a>. You can also view the scaling policies for an Auto Scaling group using <a>DescribePolicies</a>. If the group has scaling policies, you can update them using <a>PutScalingPolicy</a>.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -1409,15 +1409,15 @@
|
|||
},
|
||||
"LaunchConfigurationName":{
|
||||
"shape":"ResourceName",
|
||||
"documentation":"<p>The name of the launch configuration.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg.html\">Creating an Auto Scaling Group Using a Launch Configuration</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you do not specify <code>LaunchConfigurationName</code>, you must specify one of the following parameters: <code>InstanceId</code>, <code>LaunchTemplate</code>, or <code>MixedInstancesPolicy</code>.</p>"
|
||||
"documentation":"<p>The name of the launch configuration.</p> <p>If you do not specify <code>LaunchConfigurationName</code>, you must specify one of the following parameters: <code>InstanceId</code>, <code>LaunchTemplate</code>, or <code>MixedInstancesPolicy</code>.</p>"
|
||||
},
|
||||
"LaunchTemplate":{
|
||||
"shape":"LaunchTemplateSpecification",
|
||||
"documentation":"<p>The launch template to use to launch instances.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-launch-template.html\">Creating an Auto Scaling Group Using a Launch Template</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you do not specify <code>LaunchTemplate</code>, you must specify one of the following parameters: <code>InstanceId</code>, <code>LaunchConfigurationName</code>, or <code>MixedInstancesPolicy</code>.</p>"
|
||||
"documentation":"<p>The launch template to use to launch instances.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html\">LaunchTemplateSpecification</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>If you do not specify <code>LaunchTemplate</code>, you must specify one of the following parameters: <code>InstanceId</code>, <code>LaunchConfigurationName</code>, or <code>MixedInstancesPolicy</code>.</p>"
|
||||
},
|
||||
"MixedInstancesPolicy":{
|
||||
"shape":"MixedInstancesPolicy",
|
||||
"documentation":"<p>An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.</p> <p>The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the parameters that specify the instance configuration information—the launch template and instance types.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling Groups with Multiple Instance Types and Purchase Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You must specify one of the following parameters in your request: <code>LaunchConfigurationName</code>, <code>LaunchTemplate</code>, <code>InstanceId</code>, or <code>MixedInstancesPolicy</code>.</p>"
|
||||
"documentation":"<p>An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.</p> <p>The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the parameters that specify the instance configuration information—the launch template and instance types.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_MixedInstancesPolicy.html\">MixedInstancesPolicy</a> in the <i>Amazon EC2 Auto Scaling API Reference</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling Groups with Multiple Instance Types and Purchase Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You must specify one of the following parameters in your request: <code>LaunchConfigurationName</code>, <code>LaunchTemplate</code>, <code>InstanceId</code>, or <code>MixedInstancesPolicy</code>.</p>"
|
||||
},
|
||||
"InstanceId":{
|
||||
"shape":"XmlStringMaxLen19",
|
||||
|
|
@ -1457,7 +1457,7 @@
|
|||
},
|
||||
"HealthCheckGracePeriod":{
|
||||
"shape":"HealthCheckGracePeriod",
|
||||
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is <code>0</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html\">Health Checks for Auto Scaling Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: This parameter is required if you are adding an <code>ELB</code> health check.</p>"
|
||||
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is <code>0</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health Check Grace Period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: This parameter is required if you are adding an <code>ELB</code> health check.</p>"
|
||||
},
|
||||
"PlacementGroup":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
|
|
@ -1499,7 +1499,7 @@
|
|||
},
|
||||
"ImageId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>ImageId</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
"documentation":"<p>The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>ImageId</code>.</p>"
|
||||
},
|
||||
"KeyName":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
|
|
@ -1507,19 +1507,19 @@
|
|||
},
|
||||
"SecurityGroups":{
|
||||
"shape":"SecurityGroups",
|
||||
"documentation":"<p>One or more security groups with which to associate the instances.</p> <p>If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>If your instances are launched into a VPC, specify security group IDs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>"
|
||||
"documentation":"<p>A list that contains the security groups to assign to the instances in the Auto Scaling group.</p> <p>[EC2-VPC] Specify the security group IDs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>[EC2-Classic] Specify either the security group names or the security group IDs. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
},
|
||||
"ClassicLinkVPCId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>This parameter can only be used if you are launching EC2-Classic instances. </p>"
|
||||
},
|
||||
"ClassicLinkVPCSecurityGroups":{
|
||||
"shape":"ClassicLinkVPCSecurityGroups",
|
||||
"documentation":"<p>The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise.</p>"
|
||||
"documentation":"<p>The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you specify the <code>ClassicLinkVPCId</code> parameter, you must specify this parameter. </p>"
|
||||
},
|
||||
"UserData":{
|
||||
"shape":"XmlStringUserData",
|
||||
"documentation":"<p>The user data to make available to the launched EC2 instances. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html\">Instance Metadata and User Data</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
"documentation":"<p>The Base64-encoded user data to make available to the launched EC2 instances. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html\">Instance Metadata and User Data</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
},
|
||||
"InstanceId":{
|
||||
"shape":"XmlStringMaxLen19",
|
||||
|
|
@ -1527,7 +1527,7 @@
|
|||
},
|
||||
"InstanceType":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The instance type of the EC2 instance.</p> <p>For information about available instance types, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes\">Available Instance Types</a> in the <i>Amazon EC2 User Guide for Linux Instances.</i> </p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>InstanceType</code>.</p>"
|
||||
"documentation":"<p>Specifies the instance type of the EC2 instance.</p> <p>For information about available instance types, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes\">Available Instance Types</a> in the <i>Amazon EC2 User Guide for Linux Instances.</i> </p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>InstanceType</code>.</p>"
|
||||
},
|
||||
"KernelId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
|
|
@ -1535,35 +1535,35 @@
|
|||
},
|
||||
"RamdiskId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The ID of the RAM disk associated with the AMI.</p>"
|
||||
"documentation":"<p>The ID of the RAM disk to select.</p>"
|
||||
},
|
||||
"BlockDeviceMappings":{
|
||||
"shape":"BlockDeviceMappings",
|
||||
"documentation":"<p>One or more mappings that specify how block devices are exposed to the instance. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html\">Block Device Mapping</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
"documentation":"<p>A block device mapping, which specifies the block devices for the instance. You can specify virtual devices and EBS volumes. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html\">Block Device Mapping</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
},
|
||||
"InstanceMonitoring":{
|
||||
"shape":"InstanceMonitoring",
|
||||
"documentation":"<p>Enables detailed monitoring (<code>true</code>) or basic monitoring (<code>false</code>) for the Auto Scaling instances. The default value is <code>true</code>.</p>"
|
||||
"documentation":"<p>Controls whether instances in this group are launched with detailed (<code>true</code>) or basic (<code>false</code>) monitoring. </p> <p>The default value is <code>true</code> (enabled). </p> <important> <p>When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics\">Configure Monitoring for Auto Scaling Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p> </important>"
|
||||
},
|
||||
"SpotPrice":{
|
||||
"shape":"SpotPrice",
|
||||
"documentation":"<p>The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html\">Launching Spot Instances in Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html\">Launching Spot Instances in Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If a Spot price is set, then the Auto Scaling group will only launch instances when the Spot price has been met, regardless of the setting in the Auto Scaling group's <code>DesiredCapacity</code>. </p> <note> <p>When you change your Spot price by creating a new launch configuration, running instances will continue to run as long as the Spot price for those running instances is higher than the current Spot market price. </p> </note>"
|
||||
},
|
||||
"IamInstanceProfile":{
|
||||
"shape":"XmlStringMaxLen1600",
|
||||
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.</p> <p>EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html\">IAM Role for Applications That Run on Amazon EC2 Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html\">IAM Role for Applications That Run on Amazon EC2 Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"EbsOptimized":{
|
||||
"shape":"EbsOptimized",
|
||||
"documentation":"<p>Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html\">Amazon EBS-Optimized Instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
"documentation":"<p>Specifies whether the launch configuration is optimized for EBS I/O (<code>true</code>) or not (<code>false</code>). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html\">Amazon EBS-Optimized Instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>The default value is <code>false</code>. </p>"
|
||||
},
|
||||
"AssociatePublicIpAddress":{
|
||||
"shape":"AssociatePublicIpAddress",
|
||||
"documentation":"<p>Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.</p>"
|
||||
"documentation":"<p>For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. If you specify <code>true</code>, each instance in the Auto Scaling group receives a unique public IP address. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you specify this parameter, you must specify at least one subnet for <code>VPCZoneIdentifier</code> when you create your group.</p> <note> <p>If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.</p> </note>"
|
||||
},
|
||||
"PlacementTenancy":{
|
||||
"shape":"XmlStringMaxLen64",
|
||||
"documentation":"<p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched into a VPC.</p> <p>To launch Dedicated Instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to <code>default</code>), you must set the value of this parameter to <code>dedicated</code>.</p> <p>If you specify <code>PlacementTenancy</code>, be sure to specify at least one subnet when you create your group.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-vpc-tenancy\">Instance Placement Tenancy</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Valid values: <code>default</code> | <code>dedicated</code> </p>"
|
||||
"documentation":"<p>The tenancy of the instance. An instance with <code>dedicated</code> tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.</p> <p>To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to <code>default</code>), you must set the value of this parameter to <code>dedicated</code>.</p> <p>If you specify <code>PlacementTenancy</code>, you must specify at least one subnet for <code>VPCZoneIdentifier</code> when you create your group.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-vpc-tenancy\">Instance Placement Tenancy</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Valid values: <code>default</code> | <code>dedicated</code> </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1707,11 +1707,11 @@
|
|||
"members":{
|
||||
"MaxNumberOfAutoScalingGroups":{
|
||||
"shape":"MaxNumberOfAutoScalingGroups",
|
||||
"documentation":"<p>The maximum number of groups allowed for your AWS account. The default limit is 200 per region.</p>"
|
||||
"documentation":"<p>The maximum number of groups allowed for your AWS account. The default limit is 200 per AWS Region.</p>"
|
||||
},
|
||||
"MaxNumberOfLaunchConfigurations":{
|
||||
"shape":"MaxNumberOfLaunchConfigurations",
|
||||
"documentation":"<p>The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per region.</p>"
|
||||
"documentation":"<p>The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per AWS Region.</p>"
|
||||
},
|
||||
"NumberOfAutoScalingGroups":{
|
||||
"shape":"NumberOfAutoScalingGroups",
|
||||
|
|
@ -2359,11 +2359,11 @@
|
|||
},
|
||||
"SpotAllocationStrategy":{
|
||||
"shape":"XmlString",
|
||||
"documentation":"<p>Indicates how to allocate Spot capacity across Spot pools.</p> <p>The only valid value is <code>lowest-price</code>, which is also the default value. The Auto Scaling group selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you specify. </p>"
|
||||
"documentation":"<p>Indicates how to allocate instances across Spot Instance pools. </p> <p>If the allocation strategy is <code>lowest-price</code>, the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. If the allocation strategy is <code>capacity-optimized</code>, the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity. </p> <p>The default Spot allocation strategy for calls that you make through the API, the AWS CLI, or the AWS SDKs is <code>lowest-price</code>. The default Spot allocation strategy for the AWS Management Console is <code>capacity-optimized</code>.</p> <p>Valid values: <code>lowest-price</code> | <code>capacity-optimized</code> </p>"
|
||||
},
|
||||
"SpotInstancePools":{
|
||||
"shape":"SpotInstancePools",
|
||||
"documentation":"<p>The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of <a>LaunchTemplate</a>. The range is 1–20.</p> <p>The default value is <code>2</code>.</p>"
|
||||
"documentation":"<p>The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the Overrides array of <a>LaunchTemplate</a>. The range is 1–20. The default value is <code>2</code>. </p> <p>Valid only when the Spot allocation strategy is <code>lowest-price</code>. </p>"
|
||||
},
|
||||
"SpotMaxPrice":{
|
||||
"shape":"MixedInstanceSpotPrice",
|
||||
|
|
@ -2407,31 +2407,31 @@
|
|||
},
|
||||
"ImageId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The ID of the Amazon Machine Image (AMI).</p>"
|
||||
"documentation":"<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
},
|
||||
"KeyName":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The name of the key pair.</p>"
|
||||
"documentation":"<p>The name of the key pair.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Amazon EC2 Key Pairs</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
},
|
||||
"SecurityGroups":{
|
||||
"shape":"SecurityGroups",
|
||||
"documentation":"<p>The security groups to associate with the instances.</p>"
|
||||
"documentation":"<p>A list that contains the security groups to assign to the instances in the Auto Scaling group. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>"
|
||||
},
|
||||
"ClassicLinkVPCId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"ClassicLinkVPCSecurityGroups":{
|
||||
"shape":"ClassicLinkVPCSecurityGroups",
|
||||
"documentation":"<p>The IDs of one or more security groups for the VPC specified in <code>ClassicLinkVPCId</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise.</p>"
|
||||
"documentation":"<p>The IDs of one or more security groups for the VPC specified in <code>ClassicLinkVPCId</code>. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"UserData":{
|
||||
"shape":"XmlStringUserData",
|
||||
"documentation":"<p>The user data available to the instances.</p>"
|
||||
"documentation":"<p>The Base64-encoded user data to make available to the launched EC2 instances. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html\">Instance Metadata and User Data</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
},
|
||||
"InstanceType":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The instance type for the instances.</p>"
|
||||
"documentation":"<p>The instance type for the instances.</p> <p>For information about available instance types, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes\">Available Instance Types</a> in the <i>Amazon EC2 User Guide for Linux Instances.</i> </p>"
|
||||
},
|
||||
"KernelId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
|
|
@ -2443,19 +2443,19 @@
|
|||
},
|
||||
"BlockDeviceMappings":{
|
||||
"shape":"BlockDeviceMappings",
|
||||
"documentation":"<p>A block device mapping, which specifies the block devices for the instance.</p>"
|
||||
"documentation":"<p>A block device mapping, which specifies the block devices for the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html\">Block Device Mapping</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
},
|
||||
"InstanceMonitoring":{
|
||||
"shape":"InstanceMonitoring",
|
||||
"documentation":"<p>Controls whether instances in this group are launched with detailed (<code>true</code>) or basic (<code>false</code>) monitoring.</p>"
|
||||
"documentation":"<p>Controls whether instances in this group are launched with detailed (<code>true</code>) or basic (<code>false</code>) monitoring. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics\">Configure Monitoring for Auto Scaling Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>"
|
||||
},
|
||||
"SpotPrice":{
|
||||
"shape":"SpotPrice",
|
||||
"documentation":"<p>The price to bid when launching Spot Instances.</p>"
|
||||
"documentation":"<p>The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html\">Launching Spot Instances in Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"IamInstanceProfile":{
|
||||
"shape":"XmlStringMaxLen1600",
|
||||
"documentation":"<p>The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.</p>"
|
||||
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html\">IAM Role for Applications That Run on Amazon EC2 Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"CreatedTime":{
|
||||
"shape":"TimestampType",
|
||||
|
|
@ -2463,15 +2463,15 @@
|
|||
},
|
||||
"EbsOptimized":{
|
||||
"shape":"EbsOptimized",
|
||||
"documentation":"<p>Controls whether the instance is optimized for EBS I/O (<code>true</code>) or not (<code>false</code>).</p>"
|
||||
"documentation":"<p>Specifies whether the launch configuration is optimized for EBS I/O (<code>true</code>) or not (<code>false</code>). </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html\">Amazon EBS-Optimized Instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
},
|
||||
"AssociatePublicIpAddress":{
|
||||
"shape":"AssociatePublicIpAddress",
|
||||
"documentation":"<p>[EC2-VPC] Indicates whether to assign a public IP address to each instance.</p>"
|
||||
"documentation":"<p>For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"PlacementTenancy":{
|
||||
"shape":"XmlStringMaxLen64",
|
||||
"documentation":"<p>The tenancy of the instance, either <code>default</code> or <code>dedicated</code>. An instance with <code>dedicated</code> tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC.</p>"
|
||||
"documentation":"<p>The tenancy of the instance, either <code>default</code> or <code>dedicated</code>. An instance with <code>dedicated</code> tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-vpc-tenancy\">Instance Placement Tenancy</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a launch configuration.</p>"
|
||||
|
|
@ -2619,7 +2619,7 @@
|
|||
"documentation":"<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are <code>CONTINUE</code> and <code>ABANDON</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances. Used in response to <a>DescribeLifecycleHooks</a>.</p>"
|
||||
"documentation":"<p>Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances. Used in response to <a>DescribeLifecycleHooks</a>.</p>"
|
||||
},
|
||||
"LifecycleHookNames":{
|
||||
"type":"list",
|
||||
|
|
@ -2662,7 +2662,7 @@
|
|||
"documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a lifecycle hook. Used in combination with <a>CreateAutoScalingGroup</a>.</p> <p>A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).</p> <p>This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using <a>RecordLifecycleActionHeartbeat</a>.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action using <a>CompleteLifecycleAction</a>.</p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You can view the lifecycle hooks for an Auto Scaling group using <a>DescribeLifecycleHooks</a>. You can modify an existing lifecycle hook or create new lifecycle hooks using <a>PutLifecycleHook</a>. If you are no longer using a lifecycle hook, you can delete it using <a>DeleteLifecycleHook</a>.</p>"
|
||||
"documentation":"<p>Describes a lifecycle hook. Used in combination with <a>CreateAutoScalingGroup</a>.</p> <p>A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).</p> <p>This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using <a>RecordLifecycleActionHeartbeat</a>.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action using <a>CompleteLifecycleAction</a>.</p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You can view the lifecycle hooks for an Auto Scaling group using <a>DescribeLifecycleHooks</a>. You can modify an existing lifecycle hook or create new lifecycle hooks using <a>PutLifecycleHook</a>. If you are no longer using a lifecycle hook, you can delete it using <a>DeleteLifecycleHook</a>.</p>"
|
||||
},
|
||||
"LifecycleHookSpecifications":{
|
||||
"type":"list",
|
||||
|
|
@ -2851,7 +2851,7 @@
|
|||
"documentation":"<p>The instances distribution to use.</p> <p>If you leave this parameter unspecified when creating a mixed instances policy, the default values are used.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling Groups with Multiple Instance Types and Purchase Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You can create a mixed instances policy for a new Auto Scaling group (<a>CreateAutoScalingGroup</a>), or you can create it for an existing group by updating the group (<a>UpdateAutoScalingGroup</a>) to specify <code>MixedInstancesPolicy</code> as the top-level parameter instead of a launch configuration or template.</p>"
|
||||
"documentation":"<p>Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling Groups with Multiple Instance Types and Purchase Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify <code>MixedInstancesPolicy</code> as the top-level parameter instead of a launch configuration or template. For more information, see <a>CreateAutoScalingGroup</a> and <a>UpdateAutoScalingGroup</a>.</p>"
|
||||
},
|
||||
"MonitoringEnabled":{"type":"boolean"},
|
||||
"NoDevice":{"type":"boolean"},
|
||||
|
|
@ -3062,7 +3062,7 @@
|
|||
},
|
||||
"AdjustmentType":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The adjustment type. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p> <p>This parameter is supported if the policy type is <code>SimpleScaling</code> or <code>StepScaling</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Specifies whether the <code>ScalingAdjustment</code> parameter is an absolute number or a percentage of the current capacity. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p> <p>Valid only if the policy type is <code>StepScaling</code> or <code>SimpleScaling</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment\">Scaling Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"MinAdjustmentStep":{
|
||||
"shape":"MinAdjustmentStep",
|
||||
|
|
@ -3070,31 +3070,31 @@
|
|||
},
|
||||
"MinAdjustmentMagnitude":{
|
||||
"shape":"MinAdjustmentMagnitude",
|
||||
"documentation":"<p>The minimum number of instances to scale. If the value of <code>AdjustmentType</code> is <code>PercentChangeInCapacity</code>, the scaling policy changes the <code>DesiredCapacity</code> of the Auto Scaling group by at least this many instances. Otherwise, the error is <code>ValidationError</code>.</p> <p>This parameter is supported if the policy type is <code>SimpleScaling</code> or <code>StepScaling</code>.</p>"
|
||||
"documentation":"<p>The minimum number of instances to scale. If the value of <code>AdjustmentType</code> is <code>PercentChangeInCapacity</code>, the scaling policy changes the <code>DesiredCapacity</code> of the Auto Scaling group by at least this many instances. Otherwise, the error is <code>ValidationError</code>.</p> <p>This property replaces the <code>MinAdjustmentStep</code> property. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a <code>MinAdjustmentMagnitude</code> of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a <code>MinAdjustmentMagnitude</code> of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.</p> <p>Valid only if the policy type is <code>SimpleScaling</code> or <code>StepScaling</code>.</p>"
|
||||
},
|
||||
"ScalingAdjustment":{
|
||||
"shape":"PolicyIncrement",
|
||||
"documentation":"<p>The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.</p> <p>Conditional: This parameter is required if the policy type is <code>SimpleScaling</code> and not supported otherwise.</p>"
|
||||
"documentation":"<p>The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the <code>AdjustmentType</code> parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value. </p> <p>Conditional: If you specify <code>SimpleScaling</code> for the policy type, you must specify this parameter. (Not used with any other policy type.) </p>"
|
||||
},
|
||||
"Cooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.</p> <p>This parameter is supported if the policy type is <code>SimpleScaling</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.</p> <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"MetricAggregationType":{
|
||||
"shape":"XmlStringMaxLen32",
|
||||
"documentation":"<p>The aggregation type for the CloudWatch metrics. The valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the aggregation type is null, the value is treated as <code>Average</code>.</p> <p>This parameter is supported if the policy type is <code>StepScaling</code>.</p>"
|
||||
"documentation":"<p>The aggregation type for the CloudWatch metrics. The valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the aggregation type is null, the value is treated as <code>Average</code>.</p> <p>Valid only if the policy type is <code>StepScaling</code>.</p>"
|
||||
},
|
||||
"StepAdjustments":{
|
||||
"shape":"StepAdjustments",
|
||||
"documentation":"<p>A set of adjustments that enable you to scale based on the size of the alarm breach.</p> <p>Conditional: This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"
|
||||
"documentation":"<p>A set of adjustments that enable you to scale based on the size of the alarm breach.</p> <p>Conditional: If you specify <code>StepScaling</code> for the policy type, you must specify this parameter. (Not used with any other policy type.) </p>"
|
||||
},
|
||||
"EstimatedInstanceWarmup":{
|
||||
"shape":"EstimatedInstanceWarmup",
|
||||
"documentation":"<p>The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.</p> <p>This parameter is supported if the policy type is <code>StepScaling</code> or <code>TargetTrackingScaling</code>.</p>"
|
||||
"documentation":"<p>The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.</p> <p>Valid only if the policy type is <code>StepScaling</code> or <code>TargetTrackingScaling</code>.</p>"
|
||||
},
|
||||
"TargetTrackingConfiguration":{
|
||||
"shape":"TargetTrackingConfiguration",
|
||||
"documentation":"<p>A target tracking scaling policy. Includes support for predefined or customized metrics.</p> <p>Conditional: This parameter is required if the policy type is <code>TargetTrackingScaling</code> and not supported otherwise.</p>"
|
||||
"documentation":"<p>A target tracking scaling policy. Includes support for predefined or customized metrics.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html\">TargetTrackingConfiguration</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Conditional: If you specify <code>TargetTrackingScaling</code> for the policy type, you must specify this parameter. (Not used with any other policy type.) </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3115,7 +3115,7 @@
|
|||
},
|
||||
"Time":{
|
||||
"shape":"TimestampType",
|
||||
"documentation":"<p>This parameter is deprecated.</p>"
|
||||
"documentation":"<p>This parameter is no longer used.</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TimestampType",
|
||||
|
|
@ -3358,7 +3358,7 @@
|
|||
},
|
||||
"Time":{
|
||||
"shape":"TimestampType",
|
||||
"documentation":"<p>This parameter is deprecated.</p>"
|
||||
"documentation":"<p>This parameter is no longer used.</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TimestampType",
|
||||
|
|
@ -3710,15 +3710,15 @@
|
|||
},
|
||||
"LaunchConfigurationName":{
|
||||
"shape":"ResourceName",
|
||||
"documentation":"<p>The name of the launch configuration. If you specify <code>LaunchConfigurationName</code> in your update request, you can't specify <code>LaunchTemplate</code> or <code>MixedInstancesPolicy</code>.</p> <note> <p>To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>false</code>, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>.</p> </note>"
|
||||
"documentation":"<p>The name of the launch configuration. If you specify <code>LaunchConfigurationName</code> in your update request, you can't specify <code>LaunchTemplate</code> or <code>MixedInstancesPolicy</code>.</p> <important> <p>To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>false</code>, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>.</p> </important>"
|
||||
},
|
||||
"LaunchTemplate":{
|
||||
"shape":"LaunchTemplateSpecification",
|
||||
"documentation":"<p>The launch template and version to use to specify the updates. If you specify <code>LaunchTemplate</code> in your update request, you can't specify <code>LaunchConfigurationName</code> or <code>MixedInstancesPolicy</code>.</p>"
|
||||
"documentation":"<p>The launch template and version to use to specify the updates. If you specify <code>LaunchTemplate</code> in your update request, you can't specify <code>LaunchConfigurationName</code> or <code>MixedInstancesPolicy</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html\">LaunchTemplateSpecification</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p>"
|
||||
},
|
||||
"MixedInstancesPolicy":{
|
||||
"shape":"MixedInstancesPolicy",
|
||||
"documentation":"<p>An embedded object that specifies a mixed instances policy.</p> <p>In your call to <code>UpdateAutoScalingGroup</code>, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling Groups with Multiple Instance Types and Purchase Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>An embedded object that specifies a mixed instances policy.</p> <p>In your call to <code>UpdateAutoScalingGroup</code>, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_MixedInstancesPolicy.html\">MixedInstancesPolicy</a> in the <i>Amazon EC2 Auto Scaling API Reference</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling Groups with Multiple Instance Types and Purchase Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"MinSize":{
|
||||
"shape":"AutoScalingGroupMinSize",
|
||||
|
|
@ -3746,7 +3746,7 @@
|
|||
},
|
||||
"HealthCheckGracePeriod":{
|
||||
"shape":"HealthCheckGracePeriod",
|
||||
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is <code>0</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html\">Health Checks for Auto Scaling Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: This parameter is required if you are adding an <code>ELB</code> health check.</p>"
|
||||
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is <code>0</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health Check Grace Period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: This parameter is required if you are adding an <code>ELB</code> health check.</p>"
|
||||
},
|
||||
"PlacementGroup":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
|
|
@ -3832,5 +3832,5 @@
|
|||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.</p> <p>For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html\">Amazon EC2 Auto Scaling User Guide</a>.</p>"
|
||||
"documentation":"<fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.</p> <p>For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html\">Amazon EC2 Auto Scaling User Guide</a>.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -662,7 +662,7 @@
|
|||
},
|
||||
"linuxParameters":{
|
||||
"shape":"LinuxParameters",
|
||||
"documentation":"<p>Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.</p>"
|
||||
"documentation":"<p>Linux-specific modifications that are applied to the container, such as details for device mappings.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object representing the details of a container that is part of a job.</p>"
|
||||
|
|
@ -758,7 +758,7 @@
|
|||
},
|
||||
"linuxParameters":{
|
||||
"shape":"LinuxParameters",
|
||||
"documentation":"<p>Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.</p>"
|
||||
"documentation":"<p>Linux-specific modifications that are applied to the container, such as details for device mappings.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container properties are used in job definitions to describe the container that is launched as part of a job.</p>"
|
||||
|
|
@ -1035,7 +1035,7 @@
|
|||
},
|
||||
"containerPath":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The path inside the container at which to expose the host device.</p>"
|
||||
"documentation":"<p>The path inside the container at which to expose the host device. By default the <code>hostPath</code> value is used.</p>"
|
||||
},
|
||||
"permissions":{
|
||||
"shape":"DeviceCgroupPermissions",
|
||||
|
|
@ -1425,7 +1425,7 @@
|
|||
"documentation":"<p>Any host devices to expose to the container. This parameter maps to <code>Devices</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--device</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.</p>"
|
||||
"documentation":"<p>Linux-specific modifications that are applied to the container, such as details for device mappings.</p>"
|
||||
},
|
||||
"ListJobsRequest":{
|
||||
"type":"structure",
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceNotFound"}
|
||||
],
|
||||
"documentation":"<p>Deletes the specified alarms. In the event of an error, no alarms are deleted.</p>"
|
||||
"documentation":"<p>Deletes the specified alarms. You can delete up to 50 alarms in one operation. In the event of an error, no alarms are deleted.</p>"
|
||||
},
|
||||
"DeleteAnomalyDetector":{
|
||||
"name":"DeleteAnomalyDetector",
|
||||
|
|
@ -174,7 +174,7 @@
|
|||
"errors":[
|
||||
{"shape":"InvalidNextToken"}
|
||||
],
|
||||
"documentation":"<p>You can use the <code>GetMetricData</code> API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than calls to <code>GetMetricStatistics</code>. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p>"
|
||||
"documentation":"<p>You can use the <code>GetMetricData</code> API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than calls to <code>GetMetricStatistics</code>. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p> <p>If you omit <code>Unit</code> in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>"
|
||||
},
|
||||
"GetMetricStatistics":{
|
||||
"name":"GetMetricStatistics",
|
||||
|
|
@ -1034,11 +1034,11 @@
|
|||
},
|
||||
"StartTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time stamp indicating the earliest data to be returned.</p> <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values that align with the value of the metric's <code>Period</code> and sync up with the beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5 minutes, specifying 12:05 or 12:30 as <code>StartTime</code> can get a faster response from CloudWatch than setting 12:07 or 12:29 as the <code>StartTime</code>.</p>"
|
||||
"documentation":"<p>The time stamp indicating the earliest data to be returned.</p> <p>The value specified is inclusive; results include data points with the specified time stamp. </p> <p>CloudWatch rounds the specified time stamp as follows:</p> <ul> <li> <p>Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.</p> </li> <li> <p>Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.</p> </li> <li> <p>Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.</p> </li> </ul> <p>If you set <code>Period</code> to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15. </p> <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values that align with the value of the metric's <code>Period</code> and sync up with the beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5 minutes, specifying 12:05 or 12:30 as <code>StartTime</code> can get a faster response from CloudWatch than setting 12:07 or 12:29 as the <code>StartTime</code>.</p>"
|
||||
},
|
||||
"EndTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time stamp indicating the latest data to be returned.</p> <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values that align with the value of the metric's <code>Period</code> and sync up with the beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5 minutes, specifying 12:05 or 12:30 as <code>EndTime</code> can get a faster response from CloudWatch than setting 12:07 or 12:29 as the <code>EndTime</code>.</p>"
|
||||
"documentation":"<p>The time stamp indicating the latest data to be returned.</p> <p>The value specified is exclusive; results include data points up to the specified time stamp.</p> <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values that align with the value of the metric's <code>Period</code> and sync up with the beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5 minutes, specifying 12:05 or 12:30 as <code>EndTime</code> can get a faster response from CloudWatch than setting 12:07 or 12:29 as the <code>EndTime</code>.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
|
|
@ -1116,7 +1116,7 @@
|
|||
},
|
||||
"Unit":{
|
||||
"shape":"StandardUnit",
|
||||
"documentation":"<p>The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If you specify only a unit that the metric does not report, the results of the call are null.</p>"
|
||||
"documentation":"<p>The unit for a given metric. If you omit <code>Unit</code>, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1671,7 +1671,7 @@
|
|||
},
|
||||
"Unit":{
|
||||
"shape":"StandardUnit",
|
||||
"documentation":"<p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric. In a <code>Get</code> operation, this displays the unit that is used for the metric.</p>"
|
||||
"documentation":"<p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p> <p>In a <code>Get</code> operation, this displays the unit that is used for the metric.</p>"
|
||||
},
|
||||
"StorageResolution":{
|
||||
"shape":"StorageResolution",
|
||||
|
|
@ -1718,7 +1718,7 @@
|
|||
},
|
||||
"Unit":{
|
||||
"shape":"StandardUnit",
|
||||
"documentation":"<p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric. In a <code>Get</code> operation, this displays the unit that is used for the metric.</p>"
|
||||
"documentation":"<p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p> <p>In a <code>Get</code> operation, if you omit <code>Unit</code> then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This structure defines the metric to be returned, along with the statistics, period, and units.</p>"
|
||||
|
|
@ -1837,7 +1837,7 @@
|
|||
},
|
||||
"ActionsEnabled":{
|
||||
"shape":"ActionsEnabled",
|
||||
"documentation":"<p>Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.</p>"
|
||||
"documentation":"<p>Indicates whether actions should be executed during any changes to the alarm state. The default is <code>TRUE</code>.</p>"
|
||||
},
|
||||
"OKActions":{
|
||||
"shape":"ResourceList",
|
||||
|
|
@ -1853,7 +1853,7 @@
|
|||
},
|
||||
"MetricName":{
|
||||
"shape":"MetricName",
|
||||
"documentation":"<p>The name for the metric associated with the alarm.</p> <p>If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the <code>Dimensions</code>, <code>Period</code>, <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters. Instead, you specify all this information in the <code>Metrics</code> array.</p>"
|
||||
"documentation":"<p>The name for the metric associated with the alarm. For each <code>PutMetricAlarm</code> operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p> <p>If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the <code>Dimensions</code>, <code>Period</code>, <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters. Instead, you specify all this information in the <code>Metrics</code> array.</p>"
|
||||
},
|
||||
"Namespace":{
|
||||
"shape":"Namespace",
|
||||
|
|
@ -1873,11 +1873,11 @@
|
|||
},
|
||||
"Period":{
|
||||
"shape":"Period",
|
||||
"documentation":"<p>The length, in seconds, used each time the metric specified in <code>MetricName</code> is evaluated. Valid values are 10, 30, and any multiple of 60.</p> <p>Be sure to specify 10 or 30 only for metrics that are stored by a <code>PutMetricData</code> call with a <code>StorageResolution</code> of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>An alarm's total current evaluation period can be no longer than one day, so <code>Period</code> multiplied by <code>EvaluationPeriods</code> cannot be more than 86,400 seconds.</p>"
|
||||
"documentation":"<p>The length, in seconds, used each time the metric specified in <code>MetricName</code> is evaluated. Valid values are 10, 30, and any multiple of 60.</p> <p> <code>Period</code> is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the <code>Metrics</code> array.</p> <p>Be sure to specify 10 or 30 only for metrics that are stored by a <code>PutMetricData</code> call with a <code>StorageResolution</code> of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>An alarm's total current evaluation period can be no longer than one day, so <code>Period</code> multiplied by <code>EvaluationPeriods</code> cannot be more than 86,400 seconds.</p>"
|
||||
},
|
||||
"Unit":{
|
||||
"shape":"StandardUnit",
|
||||
"documentation":"<p>The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.</p> <p>If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm can get stuck in the <code>INSUFFICIENT DATA</code> state. </p>"
|
||||
"documentation":"<p>The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.</p> <p>If you don't specify <code>Unit</code>, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually metrics are published with only one unit, so the alarm will work as intended.</p> <p>However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and will behave un-predictably.</p> <p>We recommend omitting <code>Unit</code> so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the <code>INSUFFICIENT DATA</code> state.</p>"
|
||||
},
|
||||
"EvaluationPeriods":{
|
||||
"shape":"EvaluationPeriods",
|
||||
|
|
@ -1889,7 +1889,7 @@
|
|||
},
|
||||
"Threshold":{
|
||||
"shape":"Threshold",
|
||||
"documentation":"<p>The value against which the specified statistic is compared.</p>"
|
||||
"documentation":"<p>The value against which the specified statistic is compared.</p> <p>This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.</p>"
|
||||
},
|
||||
"ComparisonOperator":{
|
||||
"shape":"ComparisonOperator",
|
||||
|
|
@ -1905,7 +1905,7 @@
|
|||
},
|
||||
"Metrics":{
|
||||
"shape":"MetricDataQueries",
|
||||
"documentation":"<p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm based on the result of a metric math expression. Each item in the <code>Metrics</code> array either retrieves a metric or performs a math expression.</p> <p>One item in the <code>Metrics</code> array is the expression that the alarm watches. You designate this expression by setting <code>ReturnValue</code> to true for this object in the array. For more information, see <a>MetricDataQuery</a>.</p> <p>If you use the <code>Metrics</code> parameter, you cannot include the <code>MetricName</code>, <code>Dimensions</code>, <code>Period</code>, <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the <code>Metrics</code> array.</p>"
|
||||
"documentation":"<p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm based on the result of a metric math expression. For each <code>PutMetricAlarm</code> operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p> <p>Each item in the <code>Metrics</code> array either retrieves a metric or performs a math expression.</p> <p>One item in the <code>Metrics</code> array is the expression that the alarm watches. You designate this expression by setting <code>ReturnValue</code> to true for this object in the array. For more information, see <a>MetricDataQuery</a>.</p> <p>If you use the <code>Metrics</code> parameter, you cannot include the <code>MetricName</code>, <code>Dimensions</code>, <code>Period</code>, <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the <code>Metrics</code> array.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -1926,7 +1926,7 @@
|
|||
"members":{
|
||||
"Namespace":{
|
||||
"shape":"Namespace",
|
||||
"documentation":"<p>The namespace for the metric data.</p> <p>You cannot specify a namespace that begins with \"AWS/\". Namespaces that begin with \"AWS/\" are reserved for use by Amazon Web Services products.</p>"
|
||||
"documentation":"<p>The namespace for the metric data.</p> <p>To avoid conflicts with AWS service namespaces, you should not specify a namespace that begins with <code>AWS/</code> </p>"
|
||||
},
|
||||
"MetricData":{
|
||||
"shape":"MetricData",
|
||||
|
|
|
|||
|
|
@ -134,7 +134,8 @@
|
|||
"output":{"shape":"ImportSourceCredentialsOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"AccountLimitExceededException"}
|
||||
{"shape":"AccountLimitExceededException"},
|
||||
{"shape":"ResourceAlreadyExistsException"}
|
||||
],
|
||||
"documentation":"<p> Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. </p>"
|
||||
},
|
||||
|
|
@ -974,6 +975,10 @@
|
|||
"authType":{
|
||||
"shape":"AuthType",
|
||||
"documentation":"<p> The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console. </p>"
|
||||
},
|
||||
"shouldOverwrite":{
|
||||
"shape":"WrapperBoolean",
|
||||
"documentation":"<p> Set to <code>false</code> to prevent overwriting the repository source credentials. Set to <code>true</code> to overwrite the repository source credentials. The default value is <code>true</code>. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1458,7 +1463,7 @@
|
|||
},
|
||||
"privilegedMode":{
|
||||
"shape":"WrapperBoolean",
|
||||
"documentation":"<p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p>If the operating system's base image is Ubuntu Linux:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code> </p> <p> <code>- timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p> <p>If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code> </p> <p> <code>- timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>"
|
||||
"documentation":"<p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails.</p> <p>You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:</p> <p>If the operating system's base image is Ubuntu Linux:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code> </p> <p> <code>- timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p> <p>If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code> </p> <p> <code>- timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>"
|
||||
},
|
||||
"certificate":{
|
||||
"shape":"String",
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InternalException"}
|
||||
],
|
||||
"documentation":"<p>Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region. </p> <p>You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. </p> <p>For more information, see \"https://docs.aws.amazon.com/datasync/latest/userguide/working-with-agents.html#activating-agent\" (Activating an Agent) in the <i>AWS DataSync User Guide.</i> </p> <p>Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.</p> <p/>"
|
||||
"documentation":"<p>Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region.</p> <p>You can activate the agent in a VPC (Virtual private Cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public Internet.</p> <p>You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. </p> <p>Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.</p> <p/>"
|
||||
},
|
||||
"CreateLocationEfs":{
|
||||
"name":"CreateLocationEfs",
|
||||
|
|
@ -82,7 +82,7 @@
|
|||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InternalException"}
|
||||
],
|
||||
"documentation":"<p>Creates an endpoint for an Amazon S3 bucket.</p> <p>For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.</p> <p>For more information, see \"https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location\" (Configuring Amazon S3 Location Settings) in the <i>AWS DataSync User Guide</i>.</p>"
|
||||
"documentation":"<p>Creates an endpoint for an Amazon S3 bucket.</p> <p>For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.</p> <p>For more information, see Configuring Amazon S3 Location Settings in the <i>AWS DataSync User Guide.</i> </p>"
|
||||
},
|
||||
"CreateTask":{
|
||||
"name":"CreateTask",
|
||||
|
|
@ -306,7 +306,7 @@
|
|||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InternalException"}
|
||||
],
|
||||
"documentation":"<p>Starts a specific invocation of a task. A <code>TaskExecution</code> value represents an individual run of a task. Each task can have at most one <code>TaskExecution</code> at a time.</p> <p> <code>TaskExecution</code> has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. </p> <p>For detailed information, see <i>Task Execution</i> in \"https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-works.html#terminology\" (Components and Terminology) in the <i>AWS DataSync User Guide</i>.</p>"
|
||||
"documentation":"<p>Starts a specific invocation of a task. A <code>TaskExecution</code> value represents an individual run of a task. Each task can have at most one <code>TaskExecution</code> at a time.</p> <p> <code>TaskExecution</code> has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. </p> <p>For detailed information, see the Task Execution section in the Components and Terminology topic in the <i>AWS DataSync User Guide</i>.</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
|
|
@ -444,7 +444,7 @@
|
|||
"members":{
|
||||
"ActivationKey":{
|
||||
"shape":"ActivationKey",
|
||||
"documentation":"<p>Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the AWS DataSync console. </p> <p>The redirect URL returned in the response provides you the activation key for your agent in the query string parameter <code>activationKey</code>. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.</p> <p>For more information, see \"https://docs.aws.amazon.com/datasync/latest/userguide/working-with-agents.html#activating-agent\" (Activating a Agent) in the <i>AWS DataSync User Guide.</i> </p>"
|
||||
"documentation":"<p>Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the AWS DataSync console.</p> <p>The redirect URL returned in the response provides you the activation key for your agent in the query string parameter <code>activationKey</code>. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.</p> <p>For more information, see Activating an Agent in the <i>AWS DataSync User Guide.</i> </p>"
|
||||
},
|
||||
"AgentName":{
|
||||
"shape":"TagValue",
|
||||
|
|
@ -453,6 +453,18 @@
|
|||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. </p> </note>"
|
||||
},
|
||||
"VpcEndpointId":{
|
||||
"shape":"VpcEndpointId",
|
||||
"documentation":"<p>The ID of the VPC (Virtual Private Cloud) endpoint that the agent has access to. This is the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service\">Creating a VPC Endpoint Service Configuration</a> in the AWS VPC User Guide.</p> <p>VPC endpoint ID looks like this: <code>vpce-01234d5aff67890e1</code>.</p>"
|
||||
},
|
||||
"SubnetArns":{
|
||||
"shape":"PLSubnetArnList",
|
||||
"documentation":"<p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create Elastic Network Interfaces (ENIs) for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four ENIs for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four ENIs.</p>"
|
||||
},
|
||||
"SecurityGroupArns":{
|
||||
"shape":"PLSecurityGroupArnList",
|
||||
"documentation":"<p>The ARNs of the security groups used to protect your data transfer task subnets. See <a>CreateAgentRequest$SubnetArns</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>CreateAgentRequest</p>"
|
||||
|
|
@ -484,7 +496,7 @@
|
|||
},
|
||||
"Ec2Config":{
|
||||
"shape":"Ec2Config",
|
||||
"documentation":"<p>The subnet and security group that the Amazon EFS file system uses. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.</p> <p>The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows: </p> <ul> <li> <p> Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group. </p> </li> <li> <p>Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group.</p> <p>For information about security groups and mount targets, see \"https://docs.aws.amazon.com/efs/latest/ug/security-considerations.html#network-access\" (Security Groups for Amazon EC2 Instances and Mount Targets) in the <i>Amazon EFS User Guide</i>.</p> </li> </ul>"
|
||||
"documentation":"<p>The subnet and security group that the Amazon EFS file system uses. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.</p> <p>The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows: </p> <ul> <li> <p> Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group. </p> </li> <li> <p>Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group.</p> <p>For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the <i>Amazon EFS User Guide.</i> </p> </li> </ul>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -513,7 +525,7 @@
|
|||
"members":{
|
||||
"Subdirectory":{
|
||||
"shape":"NonEmptySubdirectory",
|
||||
"documentation":"<p>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. </p> <p>To see all the paths exported by your NFS server. run \"<code>showmount -e nfs-server-name</code>\" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </p> <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</p> <p>For information about NFS export configuration, see \"http://web.mit.edu/rhel-doc/5/RHEL-5-manual/Deployment_Guide-en-US/s1-nfs-server-config-exports.html\" (18.7. The /etc/exports Configuration File).</p>"
|
||||
"documentation":"<p>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. </p> <p>To see all the paths exported by your NFS server. run \"<code>showmount -e nfs-server-name</code>\" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </p> <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</p> <p>For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.</p>"
|
||||
},
|
||||
"ServerHostname":{
|
||||
"shape":"ServerHostname",
|
||||
|
|
@ -594,7 +606,7 @@
|
|||
},
|
||||
"CloudWatchLogGroupArn":{
|
||||
"shape":"LogGroupArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. </p> <p>For more information on these groups, see \"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\" (Working with Log Groups and Log Streams) in the <i>Amazon CloudWatch User Guide</i>.</p> <p>For more information about how to useCloudWatchLogs with DataSync, see \"https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html\" (Monitoring Your Task)</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. </p> <p>For more information on these groups, see Working with Log Groups and Log Streams in the <i>Amazon CloudWatch User Guide.</i> </p> <p>For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the <i>AWS DataSync User Guide.</i> </p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"TagValue",
|
||||
|
|
@ -606,7 +618,7 @@
|
|||
},
|
||||
"Excludes":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p/> <p>A filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set. </p>"
|
||||
"documentation":"<p>A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example, <code>\"/folder1|/folder2\"</code> </p> <p> </p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -707,8 +719,14 @@
|
|||
"shape":"Time",
|
||||
"documentation":"<p>The time that the agent was activated (that is, created in your account).</p>"
|
||||
},
|
||||
"EndpointOptions":{"shape":"EndpointOptions"},
|
||||
"PrivateLinkConfig":{"shape":"PrivateLinkConfig"}
|
||||
"EndpointType":{
|
||||
"shape":"EndpointType",
|
||||
"documentation":"<p>The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public Internet. </p>"
|
||||
},
|
||||
"PrivateLinkConfig":{
|
||||
"shape":"PrivateLinkConfig",
|
||||
"documentation":"<p>The subnet and the security group that DataSync used to access a VPC endpoint.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>DescribeAgentResponse</p>"
|
||||
},
|
||||
|
|
@ -826,16 +844,16 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"TaskExecutionStatus",
|
||||
"documentation":"<p>The status of the task execution. </p> <p>For detailed information about task execution statuses, see \"https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses\" (Understanding Task Statuses).</p>"
|
||||
"documentation":"<p>The status of the task execution. </p> <p>For detailed information about task execution statuses, see Understanding Task Statuses in the <i>AWS DataSync User Guide.</i> </p>"
|
||||
},
|
||||
"Options":{"shape":"Options"},
|
||||
"Excludes":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p/> <p>Specifies that the task execution excludes files from the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set. </p>"
|
||||
"documentation":"<p>A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: <code>\"/folder1|/folder2\"</code> </p> <p> </p>"
|
||||
},
|
||||
"Includes":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p/> <p>Specifies that the task execution excludes files in the transfer based on the specified pattern in the filter. When multiple include filters are set, they are interpreted as an OR. </p>"
|
||||
"documentation":"<p>A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example: <code>\"/folder1|/folder2\"</code> </p> <p> </p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"Time",
|
||||
|
|
@ -888,7 +906,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"TaskStatus",
|
||||
"documentation":"<p>The status of the task that was described.</p> <p>For detailed information about task execution statuses, see \"https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses\" (Understanding Task Statuses).</p>"
|
||||
"documentation":"<p>The status of the task that was described.</p> <p>For detailed information about task execution statuses, see Understanding Task Statuses in the <i>AWS DataSync User Guide.</i> </p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"TagValue",
|
||||
|
|
@ -908,7 +926,15 @@
|
|||
},
|
||||
"CloudWatchLogGroupArn":{
|
||||
"shape":"LogGroupArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.</p> <p>For more information on these groups, see \"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\" (Working with Log Groups and Log Streams) in the <i>Amazon CloudWatch UserGuide</i>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.</p> <p>For more information on these groups, see Working with Log Groups and Log Streams in the <i>Amazon CloudWatch User Guide</i>.</p>"
|
||||
},
|
||||
"SourceNetworkInterfaceArns":{
|
||||
"shape":"SourceNetworkInterfaceArns",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.</p>"
|
||||
},
|
||||
"DestinationNetworkInterfaceArns":{
|
||||
"shape":"DestinationNetworkInterfaceArns",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.</p>"
|
||||
},
|
||||
"Options":{
|
||||
"shape":"Options",
|
||||
|
|
@ -916,7 +942,7 @@
|
|||
},
|
||||
"Excludes":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p/> <p>Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set. </p>"
|
||||
"documentation":"<p>A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: <code>\"/folder1|/folder2\"</code> </p> <p> </p>"
|
||||
},
|
||||
"ErrorCode":{
|
||||
"shape":"string",
|
||||
|
|
@ -933,6 +959,10 @@
|
|||
},
|
||||
"documentation":"<p>DescribeTaskResponse</p>"
|
||||
},
|
||||
"DestinationNetworkInterfaceArns":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NetworkInterfaceArn"}
|
||||
},
|
||||
"Duration":{
|
||||
"type":"long",
|
||||
"min":0
|
||||
|
|
@ -976,12 +1006,18 @@
|
|||
"max":128,
|
||||
"pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$"
|
||||
},
|
||||
"EndpointOptions":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Fips":{"shape":"boolean"},
|
||||
"PrivateLink":{"shape":"boolean"}
|
||||
}
|
||||
"Endpoint":{
|
||||
"type":"string",
|
||||
"max":15,
|
||||
"min":7,
|
||||
"pattern":"\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z"
|
||||
},
|
||||
"EndpointType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PUBLIC",
|
||||
"PRIVATE_LINK"
|
||||
]
|
||||
},
|
||||
"FilterList":{
|
||||
"type":"list",
|
||||
|
|
@ -994,14 +1030,14 @@
|
|||
"members":{
|
||||
"FilterType":{
|
||||
"shape":"FilterType",
|
||||
"documentation":"<p/> <p>Specifies the type of filter rule pattern to apply. DataSync only supports the SIMPLE_PATTERN rule type.</p>"
|
||||
"documentation":"<p>The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"FilterValue",
|
||||
"documentation":"<p/> <p>A pattern that defines the filter. The filter might include or exclude files is a transfer.</p>"
|
||||
"documentation":"<p>A single filter string that consists of the patterns to include or exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: <code>/folder1|/folder2</code> </p> <p> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/> <p>A pattern that determines which files to include in the transfer or which files to exclude. </p>"
|
||||
"documentation":"<p>Specifies which files, folders and objects to include or exclude when transferring files from source to destination.</p>"
|
||||
},
|
||||
"FilterType":{
|
||||
"type":"string",
|
||||
|
|
@ -1240,6 +1276,11 @@
|
|||
"PRESERVE"
|
||||
]
|
||||
},
|
||||
"NetworkInterfaceArn":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"pattern":"^arn:aws[\\-a-z]{0,}:ec2:[a-z\\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$"
|
||||
},
|
||||
"NextToken":{
|
||||
"type":"string",
|
||||
"max":65535,
|
||||
|
|
@ -1367,10 +1408,24 @@
|
|||
"PrivateLinkConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PrivateLinkEndpoint":{"shape":"string"},
|
||||
"SubnetArns":{"shape":"PLSubnetArnList"},
|
||||
"SecurityGroupArns":{"shape":"PLSecurityGroupArnList"}
|
||||
}
|
||||
"VpcEndpointId":{
|
||||
"shape":"VpcEndpointId",
|
||||
"documentation":"<p>The ID of the VPC endpoint that is configured for an agent. An agent that is configured with a VPC endpoint will not be accessible over the public Internet.</p>"
|
||||
},
|
||||
"PrivateLinkEndpoint":{
|
||||
"shape":"Endpoint",
|
||||
"documentation":"<p>The private endpoint that is configured for an agent that has access to IP addresses in a <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html\">PrivateLink</a>. An agent that is configured with this endpoint will not be accessible over the public Internet.</p>"
|
||||
},
|
||||
"SubnetArns":{
|
||||
"shape":"PLSubnetArnList",
|
||||
"documentation":"<p>The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated in a VPC or an agent that has access to a VPC endpoint.</p>"
|
||||
},
|
||||
"SecurityGroupArns":{
|
||||
"shape":"PLSecurityGroupArnList",
|
||||
"documentation":"<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an agent activated in a VPC or an agent that has access to a VPC endpoint.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The VPC endpoint, subnet and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).</p>"
|
||||
},
|
||||
"S3BucketArn":{
|
||||
"type":"string",
|
||||
|
|
@ -1386,13 +1441,17 @@
|
|||
"documentation":"<p>The Amazon S3 bucket to access. This bucket is used as a parameter in the <a>CreateLocationS3</a> operation. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.</p> <p>For detailed information about using such a role, see \"https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location\" (Creating a Location for Amazon S3) in the <i>AWS DataSync User Guide</i>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.</p> <p>For detailed information about using such a role, see Creating a Location for Amazon S3 in the <i>AWS DataSync User Guide</i>.</p>"
|
||||
},
|
||||
"ServerHostname":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$"
|
||||
},
|
||||
"SourceNetworkInterfaceArns":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NetworkInterfaceArn"}
|
||||
},
|
||||
"StartTaskExecutionRequest":{
|
||||
"type":"structure",
|
||||
"required":["TaskArn"],
|
||||
|
|
@ -1404,7 +1463,7 @@
|
|||
"OverrideOptions":{"shape":"Options"},
|
||||
"Includes":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p/> <p>A filter that determines which files to include in the transfer during a task execution based on the specified pattern in the filter. When multiple include filters are set, they are interpreted as an OR.</p>"
|
||||
"documentation":"<p>A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe). For example: <code>\"/folder1|/folder2\"</code> </p> <p> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>StartTaskExecutionRequest</p>"
|
||||
|
|
@ -1663,7 +1722,7 @@
|
|||
"Options":{"shape":"Options"},
|
||||
"Excludes":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p/> <p>A filter that determines which files to exclude from a task based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set. </p>"
|
||||
"documentation":"<p>A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: <code>\"/folder1|/folder2\"</code> </p> <p> </p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"TagValue",
|
||||
|
|
@ -1688,7 +1747,10 @@
|
|||
"NONE"
|
||||
]
|
||||
},
|
||||
"boolean":{"type":"boolean"},
|
||||
"VpcEndpointId":{
|
||||
"type":"string",
|
||||
"pattern":"^vpce-[0-9a-f]{17}$"
|
||||
},
|
||||
"long":{"type":"long"},
|
||||
"string":{"type":"string"}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -2540,7 +2540,8 @@
|
|||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetCapacityReservationUsageRequest"},
|
||||
"output":{"shape":"GetCapacityReservationUsageResult"}
|
||||
"output":{"shape":"GetCapacityReservationUsageResult"},
|
||||
"documentation":"<p>Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each AWS account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.</p>"
|
||||
},
|
||||
"GetConsoleOutput":{
|
||||
"name":"GetConsoleOutput",
|
||||
|
|
@ -2750,7 +2751,7 @@
|
|||
},
|
||||
"input":{"shape":"ModifyFleetRequest"},
|
||||
"output":{"shape":"ModifyFleetResult"},
|
||||
"documentation":"<p>Modifies the specified EC2 Fleet.</p> <p>While the EC2 Fleet is being modified, it is in the <code>modifying</code> state.</p>"
|
||||
"documentation":"<p>Modifies the specified EC2 Fleet.</p> <p>You can only modify an EC2 Fleet request of type <code>maintain</code>.</p> <p>While the EC2 Fleet is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is <code>lowestPrice</code>, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacityOptimized</code>, EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p> <p>To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacityOptimized</code>, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.</p>"
|
||||
},
|
||||
"ModifyFpgaImageAttribute":{
|
||||
"name":"ModifyFpgaImageAttribute",
|
||||
|
|
@ -2884,7 +2885,7 @@
|
|||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ModifySnapshotAttributeRequest"},
|
||||
"documentation":"<p>Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations.</p> <p>Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.</p> <p>For more information about modifying snapshot permissions, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html\">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
"documentation":"<p>Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.</p> <p>Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.</p> <p>For more information about modifying snapshot permissions, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html\">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
},
|
||||
"ModifySpotFleetRequest":{
|
||||
"name":"ModifySpotFleetRequest",
|
||||
|
|
@ -2894,7 +2895,7 @@
|
|||
},
|
||||
"input":{"shape":"ModifySpotFleetRequestRequest"},
|
||||
"output":{"shape":"ModifySpotFleetRequestResponse"},
|
||||
"documentation":"<p>Modifies the specified Spot Fleet request.</p> <p>You can only modify a Spot Fleet request of type <code>maintain</code>.</p> <p>While the Spot Fleet request is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is <code>diversified</code>, the Spot Fleet distributes the instances across the Spot pools.</p> <p>To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>diversified</code>, the Spot Fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.</p>"
|
||||
"documentation":"<p>Modifies the specified Spot Fleet request.</p> <p>You can only modify a Spot Fleet request of type <code>maintain</code>.</p> <p>While the Spot Fleet request is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacityOptimized</code>, Spot Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p> <p>To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacityOptimized</code>, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.</p>"
|
||||
},
|
||||
"ModifySubnetAttribute":{
|
||||
"name":"ModifySubnetAttribute",
|
||||
|
|
@ -3246,7 +3247,7 @@
|
|||
},
|
||||
"input":{"shape":"RequestSpotFleetRequest"},
|
||||
"output":{"shape":"RequestSpotFleetResponse"},
|
||||
"documentation":"<p>Creates a Spot Fleet request.</p> <p>The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.</p> <p>You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.</p> <p>By default, the Spot Fleet requests Spot Instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.</p> <p>Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.</p> <p>You can specify tags for the Spot Instances. You cannot tag other resource types in a Spot Fleet request because only the <code>instance</code> resource type is supported.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html\">Spot Fleet Requests</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
"documentation":"<p>Creates a Spot Fleet request.</p> <p>The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.</p> <p>You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.</p> <p>By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.</p> <p>Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.</p> <p>You can specify tags for the Spot Instances. You cannot tag other resource types in a Spot Fleet request because only the <code>instance</code> resource type is supported.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html\">Spot Fleet Requests</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
},
|
||||
"RequestSpotInstances":{
|
||||
"name":"RequestSpotInstances",
|
||||
|
|
@ -3382,6 +3383,15 @@
|
|||
"output":{"shape":"SearchTransitGatewayRoutesResult"},
|
||||
"documentation":"<p>Searches for routes in the specified transit gateway route table.</p>"
|
||||
},
|
||||
"SendDiagnosticInterrupt":{
|
||||
"name":"SendDiagnosticInterrupt",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"SendDiagnosticInterruptRequest"},
|
||||
"documentation":"<p>Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a <i>kernel panic</i> (on Linux instances), or a <i>blue screen</i>/<i>stop error</i> (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a <i>non-maskable interrupt</i> (NMI).</p> <p>In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.</p> <p>Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.</p> <p>For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#diagnostic-interrupt\">Send a Diagnostic Interrupt</a> (Linux instances) or <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/unreachable-instance.html#diagnostic-interrupt\">Send a Diagnostic Interrupt</a> (Windows instances).</p>"
|
||||
},
|
||||
"StartInstances":{
|
||||
"name":"StartInstances",
|
||||
"http":{
|
||||
|
|
@ -3911,7 +3921,8 @@
|
|||
"type":"string",
|
||||
"enum":[
|
||||
"lowestPrice",
|
||||
"diversified"
|
||||
"diversified",
|
||||
"capacityOptimized"
|
||||
]
|
||||
},
|
||||
"AllowedPrincipal":{
|
||||
|
|
@ -5471,14 +5482,17 @@
|
|||
},
|
||||
"OwnerId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the AWS account that owns the Capacity Reservation.</p>",
|
||||
"locationName":"ownerId"
|
||||
},
|
||||
"CapacityReservationArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Capacity Reservation.</p>",
|
||||
"locationName":"capacityReservationArn"
|
||||
},
|
||||
"AvailabilityZoneId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Availability Zone ID of the Capacity Reservation.</p>",
|
||||
"locationName":"availabilityZoneId"
|
||||
},
|
||||
"InstanceType":{
|
||||
|
|
@ -5503,7 +5517,7 @@
|
|||
},
|
||||
"TotalInstanceCount":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of instances for which the Capacity Reservation reserves capacity.</p>",
|
||||
"documentation":"<p>The total number of instances for which the Capacity Reservation reserves capacity.</p>",
|
||||
"locationName":"totalInstanceCount"
|
||||
},
|
||||
"AvailableInstanceCount":{
|
||||
|
|
@ -5523,7 +5537,7 @@
|
|||
},
|
||||
"State":{
|
||||
"shape":"CapacityReservationState",
|
||||
"documentation":"<p>The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code> - The Capacity Reservation is active and the capacity is available for your use.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p> </li> </ul>",
|
||||
"documentation":"<p>The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code> - The Capacity Reservation is active and the capacity is available for your use.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p> </li> </ul>",
|
||||
"locationName":"state"
|
||||
},
|
||||
"EndDate":{
|
||||
|
|
@ -6078,7 +6092,7 @@
|
|||
},
|
||||
"SplitTunnel":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint endpoint.</p> <p>For information about split-tunnel VPN endpoints, see <a href=\"https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html\">Split-Tunnel AWS Client VPN Endpoint</a> in the <i>AWS Client VPN Administrator Guide</i>.</p>",
|
||||
"documentation":"<p>Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint.</p> <p>For information about split-tunnel VPN endpoints, see <a href=\"https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html\">Split-Tunnel AWS Client VPN Endpoint</a> in the <i>AWS Client VPN Administrator Guide</i>.</p>",
|
||||
"locationName":"splitTunnel"
|
||||
},
|
||||
"VpnProtocol":{
|
||||
|
|
@ -6635,7 +6649,10 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The Availability Zone in which to create the Capacity Reservation.</p>"
|
||||
},
|
||||
"AvailabilityZoneId":{"shape":"String"},
|
||||
"AvailabilityZoneId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the Availability Zone in which to create the Capacity Reservation.</p>"
|
||||
},
|
||||
"Tenancy":{
|
||||
"shape":"CapacityReservationTenancy",
|
||||
"documentation":"<p>Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:</p> <ul> <li> <p> <code>default</code> - The Capacity Reservation is created on hardware that is shared with other AWS accounts.</p> </li> <li> <p> <code>dedicated</code> - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.</p> </li> </ul>"
|
||||
|
|
@ -6712,7 +6729,7 @@
|
|||
},
|
||||
"DnsServers":{
|
||||
"shape":"ValueStringList",
|
||||
"documentation":"<p>Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.</p>"
|
||||
"documentation":"<p>Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.</p>"
|
||||
},
|
||||
"TransportProtocol":{
|
||||
"shape":"TransportProtocol",
|
||||
|
|
@ -6724,7 +6741,7 @@
|
|||
},
|
||||
"SplitTunnel":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint endpoint.</p> <p>By default, split-tunnel on a VPN endpoint is disabled.</p> <p>For information about split-tunnel VPN endpoints, see <a href=\"https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html\">Split-Tunnel AWS Client VPN Endpoint</a> in the <i>AWS Client VPN Administrator Guide</i>.</p>"
|
||||
"documentation":"<p>Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.</p> <p>By default, split-tunnel on a VPN endpoint is disabled.</p> <p>For information about split-tunnel VPN endpoints, see <a href=\"https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html\">Split-Tunnel AWS Client VPN Endpoint</a> in the <i>AWS Client VPN Administrator Guide</i>.</p>"
|
||||
},
|
||||
"DryRun":{
|
||||
"shape":"Boolean",
|
||||
|
|
@ -7400,7 +7417,7 @@
|
|||
},
|
||||
"SourceVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData.</p>"
|
||||
"documentation":"<p>The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in <code>LaunchTemplateData</code>. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.</p>"
|
||||
},
|
||||
"VersionDescription":{
|
||||
"shape":"VersionDescription",
|
||||
|
|
@ -8471,7 +8488,7 @@
|
|||
},
|
||||
"VolumeType":{
|
||||
"shape":"VolumeType",
|
||||
"documentation":"<p>The volume type. This can be <code>gp2</code> for General Purpose SSD, <code>io1</code> for Provisioned IOPS SSD, <code>st1</code> for Throughput Optimized HDD, <code>sc1</code> for Cold HDD, or <code>standard</code> for Magnetic volumes.</p> <p>Defaults: If no volume type is specified, the default is <code>standard</code> in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to <code>gp2</code>.</p>"
|
||||
"documentation":"<p>The volume type. This can be <code>gp2</code> for General Purpose SSD, <code>io1</code> for Provisioned IOPS SSD, <code>st1</code> for Throughput Optimized HDD, <code>sc1</code> for Cold HDD, or <code>standard</code> for Magnetic volumes.</p> <p>Default: <code>gp2</code> </p>"
|
||||
},
|
||||
"DryRun":{
|
||||
"shape":"Boolean",
|
||||
|
|
@ -12274,7 +12291,7 @@
|
|||
"members":{
|
||||
"Filters":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li> <p> <code>region-name</code> - The name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>",
|
||||
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li> <p> <code>opt-in-status</code> - The opt-in status of the Region (<code>opt-in-not-required</code> | <code>opted-in</code> | <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>",
|
||||
"locationName":"Filter"
|
||||
},
|
||||
"RegionNames":{
|
||||
|
|
@ -14346,7 +14363,7 @@
|
|||
},
|
||||
"Force":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Specifies whether to force a detachment.</p>",
|
||||
"documentation":"<p>Specifies whether to force a detachment.</p> <note> <ul> <li> <p>Use the <code>Force</code> parameter only as a last resort to detach a network interface from a failed instance. </p> </li> <li> <p>If you use the <code>Force</code> parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.</p> </li> <li> <p>If you force the detachment of a network interface, the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html\">instance metadata</a> might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.</p> </li> </ul> </note>",
|
||||
"locationName":"force"
|
||||
}
|
||||
},
|
||||
|
|
@ -14967,7 +14984,7 @@
|
|||
},
|
||||
"VolumeType":{
|
||||
"shape":"VolumeType",
|
||||
"documentation":"<p>The volume type. If you set the type to <code>io1</code>, you must also set the <b>Iops</b> property.</p> <p>Default: <code>standard</code> </p>",
|
||||
"documentation":"<p>The volume type. If you set the type to <code>io1</code>, you must also specify the IOPS that the volume supports.</p> <p>Default: <code>gp2</code> </p>",
|
||||
"locationName":"volumeType"
|
||||
},
|
||||
"Encrypted":{
|
||||
|
|
@ -16270,10 +16287,22 @@
|
|||
"type":"structure",
|
||||
"required":["CapacityReservationId"],
|
||||
"members":{
|
||||
"CapacityReservationId":{"shape":"String"},
|
||||
"NextToken":{"shape":"String"},
|
||||
"MaxResults":{"shape":"GetCapacityReservationUsageRequestMaxResults"},
|
||||
"DryRun":{"shape":"Boolean"}
|
||||
"CapacityReservationId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the Capacity Reservation.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token to retrieve the next page of results.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"GetCapacityReservationUsageRequestMaxResults",
|
||||
"documentation":"<p>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.</p> <p>Valid range: Minimum value of 1. Maximum value of 1000.</p>"
|
||||
},
|
||||
"DryRun":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetCapacityReservationUsageRequestMaxResults":{
|
||||
|
|
@ -16286,30 +16315,37 @@
|
|||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"CapacityReservationId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the Capacity Reservation.</p>",
|
||||
"locationName":"capacityReservationId"
|
||||
},
|
||||
"InstanceType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The type of instance for which the Capacity Reservation reserves capacity.</p>",
|
||||
"locationName":"instanceType"
|
||||
},
|
||||
"TotalInstanceCount":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of instances for which the Capacity Reservation reserves capacity.</p>",
|
||||
"locationName":"totalInstanceCount"
|
||||
},
|
||||
"AvailableInstanceCount":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.</p>",
|
||||
"locationName":"availableInstanceCount"
|
||||
},
|
||||
"State":{
|
||||
"shape":"CapacityReservationState",
|
||||
"documentation":"<p>The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code> - The Capacity Reservation is active and the capacity is available for your use.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p> </li> </ul>",
|
||||
"locationName":"state"
|
||||
},
|
||||
"InstanceUsages":{
|
||||
"shape":"InstanceUsageSet",
|
||||
"documentation":"<p>Information about the Capacity Reservation usage.</p>",
|
||||
"locationName":"instanceUsageSet"
|
||||
}
|
||||
}
|
||||
|
|
@ -18967,7 +19003,7 @@
|
|||
},
|
||||
"SubnetId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.</p>",
|
||||
"documentation":"<p>The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.</p>",
|
||||
"locationName":"subnetId"
|
||||
},
|
||||
"InterfaceType":{
|
||||
|
|
@ -19330,6 +19366,7 @@
|
|||
"i3en.6xlarge",
|
||||
"i3en.12xlarge",
|
||||
"i3en.24xlarge",
|
||||
"i3en.metal",
|
||||
"hi1.4xlarge",
|
||||
"hs1.8xlarge",
|
||||
"c1.medium",
|
||||
|
|
@ -19452,13 +19489,16 @@
|
|||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the AWS account that is making use of the Capacity Reservation.</p>",
|
||||
"locationName":"accountId"
|
||||
},
|
||||
"UsedInstanceCount":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of instances the AWS account currently has in the Capacity Reservation.</p>",
|
||||
"locationName":"usedInstanceCount"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the Capacity Reservation usage.</p>"
|
||||
},
|
||||
"InstanceUsageSet":{
|
||||
"type":"list",
|
||||
|
|
@ -20918,7 +20958,7 @@
|
|||
"members":{
|
||||
"Return":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Information about the Capacity Reservation.</p>",
|
||||
"documentation":"<p>Returns <code>true</code> if the request succeeds; otherwise, it returns an error.</p>",
|
||||
"locationName":"return"
|
||||
}
|
||||
}
|
||||
|
|
@ -24793,7 +24833,7 @@
|
|||
},
|
||||
"SubnetId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the subnet in which to launch the instance.</p>",
|
||||
"documentation":"<p>The IDs of the subnets in which to launch the instance. To specify multiple subnets, separate them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".</p>",
|
||||
"locationName":"subnetId"
|
||||
},
|
||||
"UserData":{
|
||||
|
|
@ -26578,7 +26618,7 @@
|
|||
},
|
||||
"VolumeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The volume type. <code>gp2</code> for General Purpose SSD, <code>io1</code> for Provisioned IOPS SSD, Throughput Optimized HDD for <code>st1</code>, Cold HDD for <code>sc1</code>, or <code>standard</code> for Magnetic.</p> <p>Default: <code>standard</code> </p>"
|
||||
"documentation":"<p>The volume type. <code>gp2</code> for General Purpose SSD, <code>io1</code> for Provisioned IOPS SSD, Throughput Optimized HDD for <code>st1</code>, Cold HDD for <code>sc1</code>, or <code>standard</code> for Magnetic.</p> <p>Default: <code>gp2</code> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an EBS volume for a Scheduled Instance.</p>"
|
||||
|
|
@ -26802,7 +26842,7 @@
|
|||
},
|
||||
"Filters":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p>One or more filters. The possible values are:</p> <ul> <li> <p> <code>attachment.transit-gateway-attachment-id</code>- The id of the transit gateway attachment.</p> </li> <li> <p> <code>attachment.resource-id</code> - The resource id of the transit gateway attachment.</p> </li> <li> <p> <code>attachment.resource-type</code> - The attachment resource type (<code>vpc</code> | <code>vpn</code>).</p> </li> <li> <p> <code>route-search.exact-match</code> - The exact match of the specified filter.</p> </li> <li> <p> <code>route-search.longest-prefix-match</code> - The longest prefix that matches the route.</p> </li> <li> <p> <code>route-search.subnet-of-match</code> - The routes with a subnet that match the specified CIDR filter.</p> </li> <li> <p> <code>route-search.supernet-of-match</code> - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.</p> </li> <li> <p> <code>state</code> - The state of the route (<code>active</code> | <code>blackhole</code>).</p> </li> <li> <p> <code>type</code> - The type of roue (<code>propagated</code> | <code>static</code>).</p> </li> </ul>",
|
||||
"documentation":"<p>One or more filters. The possible values are:</p> <ul> <li> <p> <code>attachment.transit-gateway-attachment-id</code>- The id of the transit gateway attachment.</p> </li> <li> <p> <code>attachment.resource-id</code> - The resource id of the transit gateway attachment.</p> </li> <li> <p> <code>attachment.resource-type</code> - The attachment resource type (<code>vpc</code> | <code>vpn</code>).</p> </li> <li> <p> <code>route-search.exact-match</code> - The exact match of the specified filter.</p> </li> <li> <p> <code>route-search.longest-prefix-match</code> - The longest prefix that matches the route.</p> </li> <li> <p> <code>route-search.subnet-of-match</code> - The routes with a subnet that match the specified CIDR filter.</p> </li> <li> <p> <code>route-search.supernet-of-match</code> - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.</p> </li> <li> <p> <code>state</code> - The state of the route (<code>active</code> | <code>blackhole</code>).</p> </li> <li> <p> <code>type</code> - The type of route (<code>propagated</code> | <code>static</code>).</p> </li> </ul>",
|
||||
"locationName":"Filter"
|
||||
},
|
||||
"MaxResults":{
|
||||
|
|
@ -26941,6 +26981,20 @@
|
|||
"locationName":"SecurityGroup"
|
||||
}
|
||||
},
|
||||
"SendDiagnosticInterruptRequest":{
|
||||
"type":"structure",
|
||||
"required":["InstanceId"],
|
||||
"members":{
|
||||
"InstanceId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the instance.</p>"
|
||||
},
|
||||
"DryRun":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ServiceConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -27469,7 +27523,8 @@
|
|||
"type":"string",
|
||||
"enum":[
|
||||
"lowest-price",
|
||||
"diversified"
|
||||
"diversified",
|
||||
"capacity-optimized"
|
||||
]
|
||||
},
|
||||
"SpotDatafeedSubscription":{
|
||||
|
|
@ -27518,7 +27573,7 @@
|
|||
},
|
||||
"BlockDeviceMappings":{
|
||||
"shape":"BlockDeviceMappingList",
|
||||
"documentation":"<p>One or more block devices that are mapped to the Spot instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.</p>",
|
||||
"documentation":"<p>One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.</p>",
|
||||
"locationName":"blockDeviceMapping"
|
||||
},
|
||||
"EbsOptimized":{
|
||||
|
|
@ -27578,7 +27633,7 @@
|
|||
},
|
||||
"SubnetId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-a61dafcf, subnet-65ea5f08\".</p>",
|
||||
"documentation":"<p>The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".</p>",
|
||||
"locationName":"subnetId"
|
||||
},
|
||||
"UserData":{
|
||||
|
|
@ -27650,7 +27705,7 @@
|
|||
"members":{
|
||||
"AllocationStrategy":{
|
||||
"shape":"AllocationStrategy",
|
||||
"documentation":"<p>Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is <code>lowestPrice</code>.</p>",
|
||||
"documentation":"<p>Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.</p> <p>If the allocation strategy is <code>lowestPrice</code>, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.</p> <p>If the allocation strategy is <code>diversified</code>, Spot Fleet launches instances from all the Spot Instance pools that you specify.</p> <p>If the allocation strategy is <code>capacityOptimized</code>, Spot Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p>",
|
||||
"locationName":"allocationStrategy"
|
||||
},
|
||||
"OnDemandAllocationStrategy":{
|
||||
|
|
@ -27999,7 +28054,7 @@
|
|||
"members":{
|
||||
"AllocationStrategy":{
|
||||
"shape":"SpotAllocationStrategy",
|
||||
"documentation":"<p>Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is <code>lowest-price</code>.</p>",
|
||||
"documentation":"<p>Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.</p> <p>If the allocation strategy is <code>lowestPrice</code>, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.</p> <p>If the allocation strategy is <code>diversified</code>, EC2 Fleet launches instances from all the Spot Instance pools that you specify.</p> <p>If the allocation strategy is <code>capacityOptimized</code>, EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p>",
|
||||
"locationName":"allocationStrategy"
|
||||
},
|
||||
"InstanceInterruptionBehavior":{
|
||||
|
|
@ -28040,7 +28095,7 @@
|
|||
"members":{
|
||||
"AllocationStrategy":{
|
||||
"shape":"SpotAllocationStrategy",
|
||||
"documentation":"<p>Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is <code>lowestPrice</code>.</p>"
|
||||
"documentation":"<p>Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.</p> <p>If the allocation strategy is <code>lowestPrice</code>, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.</p> <p>If the allocation strategy is <code>diversified</code>, EC2 Fleet launches instances from all the Spot Instance pools that you specify.</p> <p>If the allocation strategy is <code>capacityOptimized</code>, EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p>"
|
||||
},
|
||||
"InstanceInterruptionBehavior":{
|
||||
"shape":"SpotInstanceInterruptionBehavior",
|
||||
|
|
@ -31502,5 +31557,5 @@
|
|||
]
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>Amazon Elastic Compute Cloud</fullname> <p>Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster.</p> <p>To learn more, see the following resources:</p> <ul> <li> <p>Amazon EC2: <a href=\"http://aws.amazon.com/ec2\">Amazon EC2 product page</a>, <a href=\"http://aws.amazon.com/documentation/ec2\">Amazon EC2 documentation</a> </p> </li> <li> <p>Amazon EBS: <a href=\"http://aws.amazon.com/ebs\">Amazon EBS product page</a>, <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html\">Amazon EBS documentation</a> </p> </li> <li> <p>Amazon VPC: <a href=\"http://aws.amazon.com/vpc\">Amazon VPC product page</a>, <a href=\"http://aws.amazon.com/documentation/vpc\">Amazon VPC documentation</a> </p> </li> <li> <p>AWS VPN: <a href=\"http://aws.amazon.com/vpn\">AWS VPN product page</a>, <a href=\"http://aws.amazon.com/documentation/vpn\">AWS VPN documentation</a> </p> </li> </ul>"
|
||||
"documentation":"<fullname>Amazon Elastic Compute Cloud</fullname> <p>Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster.</p> <p>To learn more, see the following resources:</p> <ul> <li> <p>Amazon EC2: <a href=\"http://aws.amazon.com/ec2\">AmazonEC2 product page</a>, <a href=\"http://aws.amazon.com/documentation/ec2\">Amazon EC2 documentation</a> </p> </li> <li> <p>Amazon EBS: <a href=\"http://aws.amazon.com/ebs\">Amazon EBS product page</a>, <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html\">Amazon EBS documentation</a> </p> </li> <li> <p>Amazon VPC: <a href=\"http://aws.amazon.com/vpc\">Amazon VPC product page</a>, <a href=\"http://aws.amazon.com/documentation/vpc\">Amazon VPC documentation</a> </p> </li> <li> <p>AWS VPN: <a href=\"http://aws.amazon.com/vpn\">AWS VPN product page</a>, <a href=\"http://aws.amazon.com/documentation/vpn\">AWS VPN documentation</a> </p> </li> </ul>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -487,6 +487,7 @@
|
|||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"me-south-1" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
|
|
@ -627,6 +628,7 @@
|
|||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"me-south-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-1" : { },
|
||||
|
|
@ -978,6 +980,30 @@
|
|||
"ap-southeast-2" : { },
|
||||
"eu-central-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"fips-us-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-1"
|
||||
},
|
||||
"hostname" : "datasync-fips.us-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-2"
|
||||
},
|
||||
"hostname" : "datasync-fips.us-east-2.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-1"
|
||||
},
|
||||
"hostname" : "datasync-fips.us-west-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-2"
|
||||
},
|
||||
"hostname" : "datasync-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-1" : { },
|
||||
|
|
@ -1413,6 +1439,7 @@
|
|||
},
|
||||
"hostname" : "es-fips.us-west-1.amazonaws.com"
|
||||
},
|
||||
"me-south-1" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
|
|
@ -1846,6 +1873,15 @@
|
|||
"us-west-2" : { }
|
||||
}
|
||||
},
|
||||
"lakeformation" : {
|
||||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-2" : { }
|
||||
}
|
||||
},
|
||||
"lambda" : {
|
||||
"endpoints" : {
|
||||
"ap-east-1" : { },
|
||||
|
|
@ -3072,6 +3108,7 @@
|
|||
},
|
||||
"storagegateway" : {
|
||||
"endpoints" : {
|
||||
"ap-east-1" : { },
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
|
|
@ -3413,6 +3450,7 @@
|
|||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"me-south-1" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
|
|
@ -3540,7 +3578,8 @@
|
|||
"protocols" : [ "https" ]
|
||||
},
|
||||
"endpoints" : {
|
||||
"cn-north-1" : { }
|
||||
"cn-north-1" : { },
|
||||
"cn-northwest-1" : { }
|
||||
}
|
||||
},
|
||||
"directconnect" : {
|
||||
|
|
@ -3675,7 +3714,8 @@
|
|||
}
|
||||
},
|
||||
"endpoints" : {
|
||||
"cn-north-1" : { }
|
||||
"cn-north-1" : { },
|
||||
"cn-northwest-1" : { }
|
||||
}
|
||||
},
|
||||
"kinesis" : {
|
||||
|
|
@ -4036,6 +4076,12 @@
|
|||
},
|
||||
"datasync" : {
|
||||
"endpoints" : {
|
||||
"fips-us-gov-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
},
|
||||
"hostname" : "datasync-fips.us-gov-west-1.amazonaws.com"
|
||||
},
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
|
|
@ -4182,6 +4228,11 @@
|
|||
},
|
||||
"isRegionalized" : true
|
||||
},
|
||||
"health" : {
|
||||
"endpoints" : {
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"iam" : {
|
||||
"endpoints" : {
|
||||
"aws-us-gov-global" : {
|
||||
|
|
@ -4307,6 +4358,18 @@
|
|||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"route53" : {
|
||||
"endpoints" : {
|
||||
"aws-us-gov-global" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
},
|
||||
"hostname" : "route53.us-gov.amazonaws.com"
|
||||
}
|
||||
},
|
||||
"isRegionalized" : false,
|
||||
"partitionEndpoint" : "aws-us-gov-global"
|
||||
},
|
||||
"runtime.sagemaker" : {
|
||||
"endpoints" : {
|
||||
"us-gov-west-1" : { }
|
||||
|
|
@ -4385,6 +4448,9 @@
|
|||
"protocols" : [ "https" ]
|
||||
},
|
||||
"endpoints" : {
|
||||
"us-gov-east-1" : {
|
||||
"protocols" : [ "https" ]
|
||||
},
|
||||
"us-gov-west-1" : {
|
||||
"protocols" : [ "https" ]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -75,7 +75,7 @@
|
|||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"}
|
||||
],
|
||||
"documentation":"<p>Deletes multiple tables at once.</p> <note> <p>After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.</p> <p>To ensure immediate deletion of all related resources, before calling <code>BatchDeleteTable</code>, use <code>DeleteTableVersion</code> or <code>BatchDeleteTableVersion</code>, and <code>DeletePartition</code> or <code>BatchDeletePartition</code>, to delete any resources that belong to the table.</p> </note>"
|
||||
"documentation":"<p>Deletes multiple tables at once.</p> <note> <p>After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.</p> <p>To ensure the immediate deletion of all related resources, before calling <code>BatchDeleteTable</code>, use <code>DeleteTableVersion</code> or <code>BatchDeleteTableVersion</code>, and <code>DeletePartition</code> or <code>BatchDeletePartition</code>, to delete any resources that belong to the table.</p> </note>"
|
||||
},
|
||||
"BatchDeleteTableVersion":{
|
||||
"name":"BatchDeleteTableVersion",
|
||||
|
|
@ -200,6 +200,22 @@
|
|||
],
|
||||
"documentation":"<p>Stops one or more job runs for a specified job definition.</p>"
|
||||
},
|
||||
"CancelMLTaskRun":{
|
||||
"name":"CancelMLTaskRun",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CancelMLTaskRunRequest"},
|
||||
"output":{"shape":"CancelMLTaskRunResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that AWS Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling <code>CancelMLTaskRun</code> with a task run's parent transform's <code>TransformID</code> and the task run's <code>TaskRunId</code>. </p>"
|
||||
},
|
||||
"CreateClassifier":{
|
||||
"name":"CreateClassifier",
|
||||
"http":{
|
||||
|
|
@ -305,6 +321,25 @@
|
|||
],
|
||||
"documentation":"<p>Creates a new job definition.</p>"
|
||||
},
|
||||
"CreateMLTransform":{
|
||||
"name":"CreateMLTransform",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateMLTransformRequest"},
|
||||
"output":{"shape":"CreateMLTransformResponse"},
|
||||
"errors":[
|
||||
{"shape":"AlreadyExistsException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNumberLimitExceededException"},
|
||||
{"shape":"IdempotentParameterMismatchException"}
|
||||
],
|
||||
"documentation":"<p>Creates an AWS Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.</p> <p>Call this operation as the first step in the process of using a machine learning transform (such as the <code>FindMatches</code> transform) for deduplicating data. You can provide an optional <code>Description</code>, in addition to the parameters that you want to use for your algorithm.</p> <p>You must also specify certain parameters for the tasks that AWS Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include <code>Role</code>, and optionally, <code>AllocatedCapacity</code>, <code>Timeout</code>, and <code>MaxRetries</code>. For more information, see <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html\">Jobs</a>.</p>"
|
||||
},
|
||||
"CreatePartition":{
|
||||
"name":"CreatePartition",
|
||||
"http":{
|
||||
|
|
@ -490,7 +525,7 @@
|
|||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"}
|
||||
],
|
||||
"documentation":"<p>Removes a specified Database from a Data Catalog.</p> <note> <p>After completing this operation, you will no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.</p> <p>To ensure immediate deletion of all related resources, before calling <code>DeleteDatabase</code>, use <code>DeleteTableVersion</code> or <code>BatchDeleteTableVersion</code>, <code>DeletePartition</code> or <code>BatchDeletePartition</code>, <code>DeleteUserDefinedFunction</code>, and <code>DeleteTable</code> or <code>BatchDeleteTable</code>, to delete any resources that belong to the database.</p> </note>"
|
||||
"documentation":"<p>Removes a specified database from a Data Catalog.</p> <note> <p>After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.</p> <p>To ensure the immediate deletion of all related resources, before calling <code>DeleteDatabase</code>, use <code>DeleteTableVersion</code> or <code>BatchDeleteTableVersion</code>, <code>DeletePartition</code> or <code>BatchDeletePartition</code>, <code>DeleteUserDefinedFunction</code>, and <code>DeleteTable</code> or <code>BatchDeleteTable</code>, to delete any resources that belong to the database.</p> </note>"
|
||||
},
|
||||
"DeleteDevEndpoint":{
|
||||
"name":"DeleteDevEndpoint",
|
||||
|
|
@ -523,6 +558,22 @@
|
|||
],
|
||||
"documentation":"<p>Deletes a specified job definition. If the job definition is not found, no exception is thrown.</p>"
|
||||
},
|
||||
"DeleteMLTransform":{
|
||||
"name":"DeleteMLTransform",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteMLTransformRequest"},
|
||||
"output":{"shape":"DeleteMLTransformResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Deletes an AWS Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by AWS Glue. If you no longer need a transform, you can delete it by calling <code>DeleteMLTransforms</code>. However, any AWS Glue jobs that still reference the deleted transform will no longer succeed.</p>"
|
||||
},
|
||||
"DeletePartition":{
|
||||
"name":"DeletePartition",
|
||||
"http":{
|
||||
|
|
@ -586,7 +637,7 @@
|
|||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"}
|
||||
],
|
||||
"documentation":"<p>Removes a table definition from the Data Catalog.</p> <note> <p>After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.</p> <p>To ensure immediate deletion of all related resources, before calling <code>DeleteTable</code>, use <code>DeleteTableVersion</code> or <code>BatchDeleteTableVersion</code>, and <code>DeletePartition</code> or <code>BatchDeletePartition</code>, to delete any resources that belong to the table.</p> </note>"
|
||||
"documentation":"<p>Removes a table definition from the Data Catalog.</p> <note> <p>After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.</p> <p>To ensure the immediate deletion of all related resources, before calling <code>DeleteTable</code>, use <code>DeleteTableVersion</code> or <code>BatchDeleteTableVersion</code>, and <code>DeletePartition</code> or <code>BatchDeletePartition</code>, to delete any resources that belong to the table.</p> </note>"
|
||||
},
|
||||
"DeleteTableVersion":{
|
||||
"name":"DeleteTableVersion",
|
||||
|
|
@ -811,7 +862,7 @@
|
|||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"GlueEncryptionException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves all Databases defined in a given Data Catalog.</p>"
|
||||
"documentation":"<p>Retrieves all databases defined in a given Data Catalog.</p>"
|
||||
},
|
||||
"GetDataflowGraph":{
|
||||
"name":"GetDataflowGraph",
|
||||
|
|
@ -957,6 +1008,70 @@
|
|||
],
|
||||
"documentation":"<p>Retrieves all current job definitions.</p>"
|
||||
},
|
||||
"GetMLTaskRun":{
|
||||
"name":"GetMLTaskRun",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetMLTaskRunRequest"},
|
||||
"output":{"shape":"GetMLTaskRunResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that AWS Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling <code>GetMLTaskRun</code> with the <code>TaskRunID</code> and its parent transform's <code>TransformID</code>.</p>"
|
||||
},
|
||||
"GetMLTaskRuns":{
|
||||
"name":"GetMLTaskRuns",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetMLTaskRunsRequest"},
|
||||
"output":{"shape":"GetMLTaskRunsResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that AWS Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling <code>GetMLTaskRuns</code> with their parent transform's <code>TransformID</code> and other optional parameters as documented in this section.</p> <p>This operation returns a list of historic runs and must be paginated.</p>"
|
||||
},
|
||||
"GetMLTransform":{
|
||||
"name":"GetMLTransform",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetMLTransformRequest"},
|
||||
"output":{"shape":"GetMLTransformResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Gets an AWS Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by AWS Glue. You can retrieve their metadata by calling <code>GetMLTransform</code>.</p>"
|
||||
},
|
||||
"GetMLTransforms":{
|
||||
"name":"GetMLTransforms",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetMLTransformsRequest"},
|
||||
"output":{"shape":"GetMLTransformsResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Gets a sortable, filterable list of existing AWS Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by AWS Glue, and you can retrieve their metadata by calling <code>GetMLTransforms</code>.</p>"
|
||||
},
|
||||
"GetMapping":{
|
||||
"name":"GetMapping",
|
||||
"http":{
|
||||
|
|
@ -1218,7 +1333,7 @@
|
|||
{"shape":"InternalServiceException"},
|
||||
{"shape":"GlueEncryptionException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves a multiple function definitions from the Data Catalog.</p>"
|
||||
"documentation":"<p>Retrieves multiple function definitions from the Data Catalog.</p>"
|
||||
},
|
||||
"GetWorkflow":{
|
||||
"name":"GetWorkflow",
|
||||
|
|
@ -1296,7 +1411,7 @@
|
|||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"}
|
||||
],
|
||||
"documentation":"<p>Imports an existing Athena Data Catalog to AWS Glue</p>"
|
||||
"documentation":"<p>Imports an existing Amazon Athena Data Catalog to AWS Glue</p>"
|
||||
},
|
||||
"ListCrawlers":{
|
||||
"name":"ListCrawlers",
|
||||
|
|
@ -1441,6 +1556,21 @@
|
|||
],
|
||||
"documentation":"<p>Resets a bookmark entry.</p>"
|
||||
},
|
||||
"SearchTables":{
|
||||
"name":"SearchTables",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"SearchTablesRequest"},
|
||||
"output":{"shape":"SearchTablesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"}
|
||||
],
|
||||
"documentation":"<p>Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions. </p> <p>You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search. </p>"
|
||||
},
|
||||
"StartCrawler":{
|
||||
"name":"StartCrawler",
|
||||
"http":{
|
||||
|
|
@ -1473,6 +1603,39 @@
|
|||
],
|
||||
"documentation":"<p>Changes the schedule state of the specified crawler to <code>SCHEDULED</code>, unless the crawler is already running or the schedule state is already <code>SCHEDULED</code>.</p>"
|
||||
},
|
||||
"StartExportLabelsTaskRun":{
|
||||
"name":"StartExportLabelsTaskRun",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartExportLabelsTaskRunRequest"},
|
||||
"output":{"shape":"StartExportLabelsTaskRunResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning workflow. You typically use <code>StartExportLabelsTaskRun</code> when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts the <code>TransformId</code> whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a <code>TaskRunId</code>. You can check on the status of your task run by calling the <code>GetMLTaskRun</code> API.</p>"
|
||||
},
|
||||
"StartImportLabelsTaskRun":{
|
||||
"name":"StartImportLabelsTaskRun",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartImportLabelsTaskRunRequest"},
|
||||
"output":{"shape":"StartImportLabelsTaskRunResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"ResourceNumberLimitExceededException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the <code>StartMLLabelingSetGenerationTaskRun</code> call and that ultimately results in improving the quality of your machine learning transform. </p> <p>After the <code>StartMLLabelingSetGenerationTaskRun</code> finishes, AWS Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called 'labeling' in the machine learning workflows). In the case of the <code>FindMatches</code> transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to <code>StartImportLabelsTaskRun</code>. After <code>StartImportLabelsTaskRun</code> finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.</p> <p>By default, <code>StartMLLabelingSetGenerationTaskRun</code> continually learns from and combines all labels that you upload unless you set <code>Replace</code> to true. If you set <code>Replace</code> to true, <code>StartImportLabelsTaskRun</code> deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality.</p> <p>You can check on the status of your task run by calling the <code>GetMLTaskRun</code> operation. </p>"
|
||||
},
|
||||
"StartJobRun":{
|
||||
"name":"StartJobRun",
|
||||
"http":{
|
||||
|
|
@ -1491,6 +1654,41 @@
|
|||
],
|
||||
"documentation":"<p>Starts a job run using a job definition.</p>"
|
||||
},
|
||||
"StartMLEvaluationTaskRun":{
|
||||
"name":"StartMLEvaluationTaskRun",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartMLEvaluationTaskRunRequest"},
|
||||
"output":{"shape":"StartMLEvaluationTaskRunResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"ConcurrentRunsExceededException"},
|
||||
{"shape":"MLTransformNotReadyException"}
|
||||
],
|
||||
"documentation":"<p>Starts a task to estimate the quality of the transform. </p> <p>When you provide label sets as examples of truth, AWS Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.</p> <p>Returns a unique identifier for the run. You can call <code>GetMLTaskRun</code> to get more information about the stats of the <code>EvaluationTaskRun</code>.</p>"
|
||||
},
|
||||
"StartMLLabelingSetGenerationTaskRun":{
|
||||
"name":"StartMLLabelingSetGenerationTaskRun",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartMLLabelingSetGenerationTaskRunRequest"},
|
||||
"output":{"shape":"StartMLLabelingSetGenerationTaskRunResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"ConcurrentRunsExceededException"}
|
||||
],
|
||||
"documentation":"<p>Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.</p> <p>When the <code>StartMLLabelingSetGenerationTaskRun</code> finishes, AWS Glue will have generated a \"labeling set\" or a set of questions for humans to answer.</p> <p>In the case of the <code>FindMatches</code> transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” </p> <p>After the labeling process is finished, you can upload your labels with a call to <code>StartImportLabelsTaskRun</code>. After <code>StartImportLabelsTaskRun</code> finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.</p>"
|
||||
},
|
||||
"StartTrigger":{
|
||||
"name":"StartTrigger",
|
||||
"http":{
|
||||
|
|
@ -1726,6 +1924,23 @@
|
|||
],
|
||||
"documentation":"<p>Updates an existing job definition.</p>"
|
||||
},
|
||||
"UpdateMLTransform":{
|
||||
"name":"UpdateMLTransform",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateMLTransformRequest"},
|
||||
"output":{"shape":"UpdateMLTransformResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
],
|
||||
"documentation":"<p>Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.</p> <p>After calling this operation, you can call the <code>StartMLEvaluationTaskRun</code> operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).</p>"
|
||||
},
|
||||
"UpdatePartition":{
|
||||
"name":"UpdatePartition",
|
||||
"http":{
|
||||
|
|
@ -1882,7 +2097,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID.</p>"
|
||||
"documentation":"<p>The ID of the catalog in which the partition is to be created. Currently, this should be the AWS account ID.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -1903,7 +2118,7 @@
|
|||
"members":{
|
||||
"Errors":{
|
||||
"shape":"PartitionErrors",
|
||||
"documentation":"<p>Errors encountered when trying to create the requested partitions.</p>"
|
||||
"documentation":"<p>The errors encountered when trying to create the requested partitions.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1944,7 +2159,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partition to be deleted resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -1952,7 +2167,7 @@
|
|||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the table where the partitions to be deleted is located.</p>"
|
||||
"documentation":"<p>The name of the table that contains the partitions to be deleted.</p>"
|
||||
},
|
||||
"PartitionsToDelete":{
|
||||
"shape":"BatchDeletePartitionValueList",
|
||||
|
|
@ -1965,7 +2180,7 @@
|
|||
"members":{
|
||||
"Errors":{
|
||||
"shape":"PartitionErrors",
|
||||
"documentation":"<p>Errors encountered when trying to delete the requested partitions.</p>"
|
||||
"documentation":"<p>The errors encountered when trying to delete the requested partitions.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1990,11 +2205,11 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database where the tables to delete reside. For Hive compatibility, this name is entirely lowercase.</p>"
|
||||
"documentation":"<p>The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.</p>"
|
||||
},
|
||||
"TablesToDelete":{
|
||||
"shape":"BatchDeleteTableNameList",
|
||||
|
|
@ -2027,7 +2242,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -2156,7 +2371,7 @@
|
|||
},
|
||||
"UnprocessedKeys":{
|
||||
"shape":"BatchGetPartitionValueList",
|
||||
"documentation":"<p>A list of the partition values in the request for which partions were not returned.</p>"
|
||||
"documentation":"<p>A list of the partition values in the request for which partitions were not returned.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2301,6 +2516,40 @@
|
|||
"max":100,
|
||||
"min":0
|
||||
},
|
||||
"CancelMLTaskRunRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TransformId",
|
||||
"TaskRunId"
|
||||
],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the machine learning transform.</p>"
|
||||
},
|
||||
"TaskRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>A unique identifier for the task run.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CancelMLTaskRunResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the machine learning transform.</p>"
|
||||
},
|
||||
"TaskRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier for the task run.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"TaskStatusType",
|
||||
"documentation":"<p>The status for this run.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CatalogEncryptionMode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -2341,7 +2590,7 @@
|
|||
"members":{
|
||||
"ImportCompleted":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>True if the migration has completed, or False otherwise.</p>"
|
||||
"documentation":"<p> <code>True</code> if the migration has completed, or <code>False</code> otherwise.</p>"
|
||||
},
|
||||
"ImportTime":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -2529,11 +2778,15 @@
|
|||
},
|
||||
"Type":{
|
||||
"shape":"ColumnTypeString",
|
||||
"documentation":"<p>The datatype of data in the <code>Column</code>.</p>"
|
||||
"documentation":"<p>The data type of the <code>Column</code>.</p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"CommentString",
|
||||
"documentation":"<p>Free-form text comment.</p>"
|
||||
"documentation":"<p>A free-form text comment.</p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"ParametersMap",
|
||||
"documentation":"<p>These key-value pairs define properties associated with the column.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A column in a <code>Table</code>.</p>"
|
||||
|
|
@ -2542,6 +2795,12 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Column"}
|
||||
},
|
||||
"ColumnNameString":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":1,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
},
|
||||
"ColumnTypeString":{
|
||||
"type":"string",
|
||||
"max":131072,
|
||||
|
|
@ -2559,6 +2818,16 @@
|
|||
"min":0,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
},
|
||||
"Comparator":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"EQUALS",
|
||||
"GREATER_THAN",
|
||||
"LESS_THAN",
|
||||
"GREATER_THAN_EQUALS",
|
||||
"LESS_THAN_EQUALS"
|
||||
]
|
||||
},
|
||||
"ConcurrentModificationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2622,6 +2891,28 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Condition"}
|
||||
},
|
||||
"ConfusionMatrix":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NumTruePositives":{
|
||||
"shape":"RecordsCount",
|
||||
"documentation":"<p>The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.</p>"
|
||||
},
|
||||
"NumFalsePositives":{
|
||||
"shape":"RecordsCount",
|
||||
"documentation":"<p>The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.</p>"
|
||||
},
|
||||
"NumTrueNegatives":{
|
||||
"shape":"RecordsCount",
|
||||
"documentation":"<p>The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.</p>"
|
||||
},
|
||||
"NumFalseNegatives":{
|
||||
"shape":"RecordsCount",
|
||||
"documentation":"<p>The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.</p> <p>For more information, see <a href=\"https://en.wikipedia.org/wiki/Confusion_matrix\">Confusion matrix</a> in Wikipedia.</p>"
|
||||
},
|
||||
"Connection":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2643,7 +2934,7 @@
|
|||
},
|
||||
"ConnectionProperties":{
|
||||
"shape":"ConnectionProperties",
|
||||
"documentation":"<p>These key-value pairs define parameters for the connection:</p> <ul> <li> <p> <code>HOST</code> - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.</p> </li> <li> <p> <code>PORT</code> - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.</p> </li> <li> <p> <code>USER_NAME</code> - The name under which to log in to the database. The value string for <code>USER_NAME</code> is \"<code>USERNAME</code>\".</p> </li> <li> <p> <code>PASSWORD</code> - A password, if one is used, for the user name.</p> </li> <li> <p> <code>ENCRYPTED_PASSWORD</code> - When you enable connection password protection by setting <code>ConnectionPasswordEncryption</code> in the Data Catalog encryption settings, this field stores the encrypted password.</p> </li> <li> <p> <code>JDBC_DRIVER_JAR_URI</code> - The Amazon S3 path of the JAR file that contains the JDBC driver to use.</p> </li> <li> <p> <code>JDBC_DRIVER_CLASS_NAME</code> - The class name of the JDBC driver to use.</p> </li> <li> <p> <code>JDBC_ENGINE</code> - The name of the JDBC engine to use.</p> </li> <li> <p> <code>JDBC_ENGINE_VERSION</code> - The version of the JDBC engine to use.</p> </li> <li> <p> <code>CONFIG_FILES</code> - (Reserved for future use).</p> </li> <li> <p> <code>INSTANCE_ID</code> - The instance ID to use.</p> </li> <li> <p> <code>JDBC_CONNECTION_URL</code> - The URL for the JDBC connection.</p> </li> <li> <p> <code>JDBC_ENFORCE_SSL</code> - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching will be enforced for the JDBC connection on the client. The default is false.</p> </li> </ul>"
|
||||
"documentation":"<p>These key-value pairs define parameters for the connection:</p> <ul> <li> <p> <code>HOST</code> - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.</p> </li> <li> <p> <code>PORT</code> - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.</p> </li> <li> <p> <code>USER_NAME</code> - The name under which to log in to the database. The value string for <code>USER_NAME</code> is \"<code>USERNAME</code>\".</p> </li> <li> <p> <code>PASSWORD</code> - A password, if one is used, for the user name.</p> </li> <li> <p> <code>ENCRYPTED_PASSWORD</code> - When you enable connection password protection by setting <code>ConnectionPasswordEncryption</code> in the Data Catalog encryption settings, this field stores the encrypted password.</p> </li> <li> <p> <code>JDBC_DRIVER_JAR_URI</code> - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.</p> </li> <li> <p> <code>JDBC_DRIVER_CLASS_NAME</code> - The class name of the JDBC driver to use.</p> </li> <li> <p> <code>JDBC_ENGINE</code> - The name of the JDBC engine to use.</p> </li> <li> <p> <code>JDBC_ENGINE_VERSION</code> - The version of the JDBC engine to use.</p> </li> <li> <p> <code>CONFIG_FILES</code> - (Reserved for future use.)</p> </li> <li> <p> <code>INSTANCE_ID</code> - The instance ID to use.</p> </li> <li> <p> <code>JDBC_CONNECTION_URL</code> - The URL for the JDBC connection.</p> </li> <li> <p> <code>JDBC_ENFORCE_SSL</code> - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.</p> </li> </ul>"
|
||||
},
|
||||
"PhysicalConnectionRequirements":{
|
||||
"shape":"PhysicalConnectionRequirements",
|
||||
|
|
@ -2717,7 +3008,7 @@
|
|||
"documentation":"<p>An AWS KMS key that is used to encrypt the connection password. </p> <p>If connection password protection is enabled, the caller of <code>CreateConnection</code> and <code>UpdateConnection</code> needs at least <code>kms:Encrypt</code> permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog. </p> <p>You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The data structure used by the Data Catalog to encrypt the password as part of <code>CreateConnection</code> or <code>UpdateConnection</code> and store it in the <code>ENCRYPTED_PASSWORD</code> field in the connection properties. You can enable catalog encryption or only password encryption.</p> <p>When a <code>CreationConnection</code> request arrives containing a password, the Data Catalog first encrypts the password using your AWS KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.</p> <p>This encryption requires that you set AWS KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only admin users to have decrypt permission on the password key.</p>"
|
||||
"documentation":"<p>The data structure used by the Data Catalog to encrypt the password as part of <code>CreateConnection</code> or <code>UpdateConnection</code> and store it in the <code>ENCRYPTED_PASSWORD</code> field in the connection properties. You can enable catalog encryption or only password encryption.</p> <p>When a <code>CreationConnection</code> request arrives containing a password, the Data Catalog first encrypts the password using your AWS KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.</p> <p>This encryption requires that you set AWS KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.</p>"
|
||||
},
|
||||
"ConnectionProperties":{
|
||||
"type":"map",
|
||||
|
|
@ -3158,11 +3449,11 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which to create the database. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog in which to create the database. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseInput":{
|
||||
"shape":"DatabaseInput",
|
||||
"documentation":"<p>A <code>DatabaseInput</code> object defining the metadata database to create in the catalog.</p>"
|
||||
"documentation":"<p>The metadata for the database.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3208,7 +3499,7 @@
|
|||
},
|
||||
"WorkerType":{
|
||||
"shape":"WorkerType",
|
||||
"documentation":"<p>The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> </ul>"
|
||||
"documentation":"<p>The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> </ul> <p>Known issue: when a development endpoint is created with the <code>G.2X</code> <code>WorkerType</code> configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. </p>"
|
||||
},
|
||||
"NumberOfWorkers":{
|
||||
"shape":"NullableInteger",
|
||||
|
|
@ -3451,6 +3742,66 @@
|
|||
},
|
||||
"documentation":"<p>Specifies a JSON classifier for <code>CreateClassifier</code> to create.</p>"
|
||||
},
|
||||
"CreateMLTransformRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"InputRecordTables",
|
||||
"Parameters",
|
||||
"Role"
|
||||
],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The unique name that you give the transform when you create it.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>A description of the machine learning transform that is being defined. The default is an empty string.</p>"
|
||||
},
|
||||
"InputRecordTables":{
|
||||
"shape":"GlueTables",
|
||||
"documentation":"<p>A list of AWS Glue table definitions used by the transform.</p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"TransformParameters",
|
||||
"documentation":"<p>The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.</p>"
|
||||
},
|
||||
"Role":{
|
||||
"shape":"RoleString",
|
||||
"documentation":"<p>The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Ensure that this role has permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries that are used by the task run for this transform.</p>"
|
||||
},
|
||||
"MaxCapacity":{
|
||||
"shape":"NullableDouble",
|
||||
"documentation":"<p>The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>. </p> <p>When the <code>WorkerType</code> field is set to a value other than <code>Standard</code>, the <code>MaxCapacity</code> field is set automatically and becomes read-only.</p>"
|
||||
},
|
||||
"WorkerType":{
|
||||
"shape":"WorkerType",
|
||||
"documentation":"<p>The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.</p> </li> </ul>"
|
||||
},
|
||||
"NumberOfWorkers":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p>The number of workers of a defined <code>workerType</code> that are allocated when this task runs.</p>"
|
||||
},
|
||||
"Timeout":{
|
||||
"shape":"Timeout",
|
||||
"documentation":"<p>The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>"
|
||||
},
|
||||
"MaxRetries":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p>The maximum number of times to retry a task for this transform after a task run fails.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateMLTransformResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>A unique identifier that is generated for the transform.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreatePartitionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3461,7 +3812,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID.</p>"
|
||||
"documentation":"<p>The AWS account ID of the catalog in which the partition is to be created.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -3632,7 +3983,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which to create the function. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog in which to create the function. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -3802,17 +4153,32 @@
|
|||
},
|
||||
"documentation":"<p>Contains configuration information for maintaining Data Catalog security.</p>"
|
||||
},
|
||||
"DataLakePrincipal":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DataLakePrincipalIdentifier":{
|
||||
"shape":"DataLakePrincipalString",
|
||||
"documentation":"<p>An identifier for the AWS Lake Formation principal.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The AWS Lake Formation principal.</p>"
|
||||
},
|
||||
"DataLakePrincipalString":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1
|
||||
},
|
||||
"Database":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Name of the database. For Hive compatibility, this is folded to lowercase when it is stored.</p>"
|
||||
"documentation":"<p>The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>Description of the database.</p>"
|
||||
"documentation":"<p>A description of the database.</p>"
|
||||
},
|
||||
"LocationUri":{
|
||||
"shape":"URI",
|
||||
|
|
@ -3825,9 +4191,13 @@
|
|||
"CreateTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time at which the metadata database was created in the catalog.</p>"
|
||||
},
|
||||
"CreateTableDefaultPermissions":{
|
||||
"shape":"PrincipalPermissionsList",
|
||||
"documentation":"<p>Creates a set of default permissions on the table for principals. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The <code>Database</code> object represents a logical grouping of tables that may reside in a Hive metastore or an RDBMS.</p>"
|
||||
"documentation":"<p>The <code>Database</code> object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.</p>"
|
||||
},
|
||||
"DatabaseInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -3835,19 +4205,23 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Name of the database. For Hive compatibility, this is folded to lowercase when it is stored.</p>"
|
||||
"documentation":"<p>The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>Description of the database</p>"
|
||||
"documentation":"<p>A description of the database.</p>"
|
||||
},
|
||||
"LocationUri":{
|
||||
"shape":"URI",
|
||||
"documentation":"<p>The location of the database (for example, an HDFS path).</p>"
|
||||
"documentation":"<p>The location of the database (for example, an HDFS path). </p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"ParametersMap",
|
||||
"documentation":"<p>Thes key-value pairs define parameters and properties of the database.</p>"
|
||||
"documentation":"<p>These key-value pairs define parameters and properties of the database.</p> <p>These key-value pairs define parameters and properties of the database.</p>"
|
||||
},
|
||||
"CreateTableDefaultPermissions":{
|
||||
"shape":"PrincipalPermissionsList",
|
||||
"documentation":"<p>Creates a set of default permissions on the table for principals. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure used to create or update a database.</p>"
|
||||
|
|
@ -3926,11 +4300,11 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog in which the database resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the Database to delete. For Hive compatibility, this must be all lowercase.</p>"
|
||||
"documentation":"<p>The name of the database to delete. For Hive compatibility, this must be all lowercase.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3973,6 +4347,25 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DeleteMLTransformRequest":{
|
||||
"type":"structure",
|
||||
"required":["TransformId"],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the transform to delete.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteMLTransformResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the transform that was deleted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeletePartitionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3983,7 +4376,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partition to be deleted resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -3991,7 +4384,7 @@
|
|||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the table where the partition to be deleted is located.</p>"
|
||||
"documentation":"<p>The name of the table that contains the partition to be deleted.</p>"
|
||||
},
|
||||
"PartitionValues":{
|
||||
"shape":"ValueStringList",
|
||||
|
|
@ -4042,7 +4435,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -4069,7 +4462,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -4207,7 +4600,7 @@
|
|||
},
|
||||
"WorkerType":{
|
||||
"shape":"WorkerType",
|
||||
"documentation":"<p>The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> </ul>"
|
||||
"documentation":"<p>The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> </ul> <p>Known issue: when a development endpoint is created with the <code>G.2X</code> <code>WorkerType</code> configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. </p>"
|
||||
},
|
||||
"NumberOfWorkers":{
|
||||
"shape":"NullableInteger",
|
||||
|
|
@ -4392,6 +4785,21 @@
|
|||
"documentation":"<p>Contains details about an error.</p>"
|
||||
},
|
||||
"ErrorString":{"type":"string"},
|
||||
"EvaluationMetrics":{
|
||||
"type":"structure",
|
||||
"required":["TransformType"],
|
||||
"members":{
|
||||
"TransformType":{
|
||||
"shape":"TransformType",
|
||||
"documentation":"<p>The type of machine learning transform.</p>"
|
||||
},
|
||||
"FindMatchesMetrics":{
|
||||
"shape":"FindMatchesMetrics",
|
||||
"documentation":"<p>The evaluation metrics for the find matches algorithm.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Evaluation metrics provide an estimate of the quality of your machine learning transform.</p>"
|
||||
},
|
||||
"ExecutionProperty":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -4411,6 +4819,16 @@
|
|||
"NONE"
|
||||
]
|
||||
},
|
||||
"ExportLabelsTaskRunProperties":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"OutputS3Path":{
|
||||
"shape":"UriString",
|
||||
"documentation":"<p>The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies configuration properties for an exporting labels task run.</p>"
|
||||
},
|
||||
"FieldType":{"type":"string"},
|
||||
"FilterString":{
|
||||
"type":"string",
|
||||
|
|
@ -4418,11 +4836,83 @@
|
|||
"min":0,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
},
|
||||
"FindMatchesMetrics":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AreaUnderPRCurve":{
|
||||
"shape":"GenericBoundedDouble",
|
||||
"documentation":"<p>The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.</p> <p>For more information, see <a href=\"https://en.wikipedia.org/wiki/Precision_and_recall\">Precision and recall</a> in Wikipedia.</p>"
|
||||
},
|
||||
"Precision":{
|
||||
"shape":"GenericBoundedDouble",
|
||||
"documentation":"<p>The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.</p> <p>For more information, see <a href=\"https://en.wikipedia.org/wiki/Precision_and_recall\">Precision and recall</a> in Wikipedia.</p>"
|
||||
},
|
||||
"Recall":{
|
||||
"shape":"GenericBoundedDouble",
|
||||
"documentation":"<p>The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.</p> <p>For more information, see <a href=\"https://en.wikipedia.org/wiki/Precision_and_recall\">Precision and recall</a> in Wikipedia.</p>"
|
||||
},
|
||||
"F1":{
|
||||
"shape":"GenericBoundedDouble",
|
||||
"documentation":"<p>The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.</p> <p>For more information, see <a href=\"https://en.wikipedia.org/wiki/F1_score\">F1 score</a> in Wikipedia.</p>"
|
||||
},
|
||||
"ConfusionMatrix":{
|
||||
"shape":"ConfusionMatrix",
|
||||
"documentation":"<p>The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.</p> <p>For more information, see <a href=\"https://en.wikipedia.org/wiki/Confusion_matrix\">Confusion matrix</a> in Wikipedia.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The evaluation metrics for the find matches algorithm. The quality of your machine learning transform is measured by getting your transform to predict some matches and comparing the results to known matches from the same dataset. The quality metrics are based on a subset of your data, so they are not precise.</p>"
|
||||
},
|
||||
"FindMatchesParameters":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PrimaryKeyColumnName":{
|
||||
"shape":"ColumnNameString",
|
||||
"documentation":"<p>The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.</p>"
|
||||
},
|
||||
"PrecisionRecallTradeoff":{
|
||||
"shape":"GenericBoundedDouble",
|
||||
"documentation":"<p>The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.</p> <p>The precision metric indicates how often your model is correct when it predicts a match. </p> <p>The recall metric indicates that for an actual match, how often your model predicts the match.</p>"
|
||||
},
|
||||
"AccuracyCostTradeoff":{
|
||||
"shape":"GenericBoundedDouble",
|
||||
"documentation":"<p>The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate <code>FindMatches</code> transform, sometimes with unacceptable accuracy.</p> <p>Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall. </p> <p>Cost measures how many compute resources, and thus money, are consumed to run the transform.</p>"
|
||||
},
|
||||
"EnforceProvidedLabels":{
|
||||
"shape":"NullableBoolean",
|
||||
"documentation":"<p>The value to switch on or off to force the output to match the provided labels from users. If the value is <code>True</code>, the <code>find matches</code> transform forces the output to match the provided labels. The results override the normal conflation results. If the value is <code>False</code>, the <code>find matches</code> transform does not ensure all the labels provided are respected, and the results rely on the trained model.</p> <p>Note that setting this value to true may increase the conflation execution time.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The parameters to configure the find matches transform.</p>"
|
||||
},
|
||||
"FindMatchesTaskRunProperties":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"JobId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The job ID for the Find Matches task run.</p>"
|
||||
},
|
||||
"JobName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name assigned to the job for the Find Matches task run.</p>"
|
||||
},
|
||||
"JobRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The job run ID for the Find Matches task run.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies configuration properties for a Find Matches task run.</p>"
|
||||
},
|
||||
"FormatString":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
},
|
||||
"GenericBoundedDouble":{
|
||||
"type":"double",
|
||||
"box":true,
|
||||
"max":1.0,
|
||||
"min":0.0
|
||||
},
|
||||
"GenericMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"GenericString"},
|
||||
|
|
@ -4506,7 +4996,7 @@
|
|||
},
|
||||
"HidePassword":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties.</p>"
|
||||
"documentation":"<p>Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4542,11 +5032,11 @@
|
|||
},
|
||||
"Filter":{
|
||||
"shape":"GetConnectionsFilter",
|
||||
"documentation":"<p>A filter that controls which connections will be returned.</p>"
|
||||
"documentation":"<p>A filter that controls which connections are returned.</p>"
|
||||
},
|
||||
"HidePassword":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties.</p>"
|
||||
"documentation":"<p>Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
|
|
@ -4651,7 +5141,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog for which to retrieve the security configuration. If none is provided, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the AWS account ID is used by default.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4670,7 +5160,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog in which the database resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -4683,7 +5173,7 @@
|
|||
"members":{
|
||||
"Database":{
|
||||
"shape":"Database",
|
||||
"documentation":"<p>The definition of the specified database in the catalog.</p>"
|
||||
"documentation":"<p>The definition of the specified database in the Data Catalog.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4692,7 +5182,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog from which to retrieve <code>Databases</code>. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog from which to retrieve <code>Databases</code>. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
|
|
@ -4945,6 +5435,225 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"GetMLTaskRunRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TransformId",
|
||||
"TaskRunId"
|
||||
],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the machine learning transform.</p>"
|
||||
},
|
||||
"TaskRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the task run.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetMLTaskRunResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the task run.</p>"
|
||||
},
|
||||
"TaskRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique run identifier associated with this run.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"TaskStatusType",
|
||||
"documentation":"<p>The status for this task run.</p>"
|
||||
},
|
||||
"LogGroupName":{
|
||||
"shape":"GenericString",
|
||||
"documentation":"<p>The names of the log groups that are associated with the task run.</p>"
|
||||
},
|
||||
"Properties":{
|
||||
"shape":"TaskRunProperties",
|
||||
"documentation":"<p>The list of properties that are associated with the task run.</p>"
|
||||
},
|
||||
"ErrorString":{
|
||||
"shape":"GenericString",
|
||||
"documentation":"<p>The error strings that are associated with the task run.</p>"
|
||||
},
|
||||
"StartedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when this task run started.</p>"
|
||||
},
|
||||
"LastModifiedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when this task run was last modified.</p>"
|
||||
},
|
||||
"CompletedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when this task run was completed.</p>"
|
||||
},
|
||||
"ExecutionTime":{
|
||||
"shape":"ExecutionTime",
|
||||
"documentation":"<p>The amount of time (in seconds) that the task run consumed resources.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetMLTaskRunsRequest":{
|
||||
"type":"structure",
|
||||
"required":["TransformId"],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the machine learning transform.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>A token for pagination of the results. The default is empty.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum number of results to return. </p>"
|
||||
},
|
||||
"Filter":{
|
||||
"shape":"TaskRunFilterCriteria",
|
||||
"documentation":"<p>The filter criteria, in the <code>TaskRunFilterCriteria</code> structure, for the task run.</p>"
|
||||
},
|
||||
"Sort":{
|
||||
"shape":"TaskRunSortCriteria",
|
||||
"documentation":"<p>The sorting criteria, in the <code>TaskRunSortCriteria</code> structure, for the task run.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetMLTaskRunsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TaskRuns":{
|
||||
"shape":"TaskRunList",
|
||||
"documentation":"<p>A list of task runs that are associated with the transform.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>A pagination token, if more results are available.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetMLTransformRequest":{
|
||||
"type":"structure",
|
||||
"required":["TransformId"],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the transform, generated at the time that the transform was created.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetMLTransformResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the transform, generated at the time that the transform was created.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The unique name given to the transform when it was created.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>A description of the transform.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"TransformStatusType",
|
||||
"documentation":"<p>The last known status of the transform (to indicate whether it can be used or not). One of \"NOT_READY\", \"READY\", or \"DELETING\".</p>"
|
||||
},
|
||||
"CreatedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the transform was created.</p>"
|
||||
},
|
||||
"LastModifiedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the transform was last modified.</p>"
|
||||
},
|
||||
"InputRecordTables":{
|
||||
"shape":"GlueTables",
|
||||
"documentation":"<p>A list of AWS Glue table definitions used by the transform.</p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"TransformParameters",
|
||||
"documentation":"<p>The configuration parameters that are specific to the algorithm used.</p>"
|
||||
},
|
||||
"EvaluationMetrics":{
|
||||
"shape":"EvaluationMetrics",
|
||||
"documentation":"<p>The latest evaluation metrics.</p>"
|
||||
},
|
||||
"LabelCount":{
|
||||
"shape":"LabelCount",
|
||||
"documentation":"<p>The number of labels available for this transform.</p>"
|
||||
},
|
||||
"Schema":{
|
||||
"shape":"TransformSchema",
|
||||
"documentation":"<p>The <code>Map<Column, Type></code> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.</p>"
|
||||
},
|
||||
"Role":{
|
||||
"shape":"RoleString",
|
||||
"documentation":"<p>The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.</p>"
|
||||
},
|
||||
"MaxCapacity":{
|
||||
"shape":"NullableDouble",
|
||||
"documentation":"<p>The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>. </p> <p>When the <code>WorkerType</code> field is set to a value other than <code>Standard</code>, the <code>MaxCapacity</code> field is set automatically and becomes read-only.</p>"
|
||||
},
|
||||
"WorkerType":{
|
||||
"shape":"WorkerType",
|
||||
"documentation":"<p>The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.</p> </li> </ul>"
|
||||
},
|
||||
"NumberOfWorkers":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p>The number of workers of a defined <code>workerType</code> that are allocated when this task runs.</p>"
|
||||
},
|
||||
"Timeout":{
|
||||
"shape":"Timeout",
|
||||
"documentation":"<p>The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>"
|
||||
},
|
||||
"MaxRetries":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p>The maximum number of times to retry a task for this transform after a task run fails.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetMLTransformsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>A paginated token to offset the results.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum number of results to return.</p>"
|
||||
},
|
||||
"Filter":{
|
||||
"shape":"TransformFilterCriteria",
|
||||
"documentation":"<p>The filter transformation criteria.</p>"
|
||||
},
|
||||
"Sort":{
|
||||
"shape":"TransformSortCriteria",
|
||||
"documentation":"<p>The sorting criteria.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetMLTransformsResponse":{
|
||||
"type":"structure",
|
||||
"required":["Transforms"],
|
||||
"members":{
|
||||
"Transforms":{
|
||||
"shape":"TransformList",
|
||||
"documentation":"<p>A list of machine learning transforms.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>A pagination token, if more results are available.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetMappingRequest":{
|
||||
"type":"structure",
|
||||
"required":["Source"],
|
||||
|
|
@ -4983,7 +5692,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partition in question resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the partition in question resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -5017,7 +5726,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -5029,7 +5738,7 @@
|
|||
},
|
||||
"Expression":{
|
||||
"shape":"PredicateString",
|
||||
"documentation":"<p>An expression filtering the partitions to be returned.</p> <p>The expression uses SQL syntax similar to the SQL <code>WHERE</code> filter clause. The SQL statement parser <a href=\"http://jsqlparser.sourceforge.net/home.php\">JSQLParser</a> parses the expression. </p> <p> <i>Operators</i>: The following are the operators that you can use in the <code>Expression</code> API call:</p> <dl> <dt>=</dt> <dd> <p>Checks if the values of the two operands are equal or not; if yes, then the condition becomes true.</p> <p>Example: Assume 'variable a' holds 10 and 'variable b' holds 20. </p> <p>(a = b) is not true.</p> </dd> <dt>< ></dt> <dd> <p>Checks if the values of two operands are equal or not; if the values are not equal, then the condition becomes true.</p> <p>Example: (a < > b) is true.</p> </dd> <dt>></dt> <dd> <p>Checks if the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a > b) is not true.</p> </dd> <dt><</dt> <dd> <p>Checks if the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a < b) is true.</p> </dd> <dt>>=</dt> <dd> <p>Checks if the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a >= b) is not true.</p> </dd> <dt><=</dt> <dd> <p>Checks if the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a <= b) is true.</p> </dd> <dt>AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL</dt> <dd> <p>Logical operators.</p> </dd> </dl> <p> <i>Supported Partition Key Types</i>: The following are the the supported partition keys.</p> <ul> <li> <p> <code>string</code> </p> </li> <li> <p> <code>date</code> </p> </li> <li> <p> <code>timestamp</code> </p> </li> <li> <p> <code>int</code> </p> </li> <li> <p> <code>bigint</code> </p> </li> <li> <p> <code>long</code> </p> </li> <li> <p> <code>tinyint</code> </p> </li> <li> <p> <code>smallint</code> </p> </li> <li> <p> <code>decimal</code> </p> </li> </ul> <p>If an invalid type is encountered, an exception is thrown. </p> <p>The following list shows the valid operators on each type. When you define a crawler, the <code>partitionKey</code> type is created as a <code>STRING</code>, to be compatible with the catalog partitions. </p> <p> <i>Sample API Call</i>: </p>"
|
||||
"documentation":"<p>An expression that filters the partitions to be returned.</p> <p>The expression uses SQL syntax similar to the SQL <code>WHERE</code> filter clause. The SQL statement parser <a href=\"http://jsqlparser.sourceforge.net/home.php\">JSQLParser</a> parses the expression. </p> <p> <i>Operators</i>: The following are the operators that you can use in the <code>Expression</code> API call:</p> <dl> <dt>=</dt> <dd> <p>Checks whether the values of the two operands are equal; if yes, then the condition becomes true.</p> <p>Example: Assume 'variable a' holds 10 and 'variable b' holds 20. </p> <p>(a = b) is not true.</p> </dd> <dt>< ></dt> <dd> <p>Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.</p> <p>Example: (a < > b) is true.</p> </dd> <dt>></dt> <dd> <p>Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a > b) is not true.</p> </dd> <dt><</dt> <dd> <p>Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a < b) is true.</p> </dd> <dt>>=</dt> <dd> <p>Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a >= b) is not true.</p> </dd> <dt><=</dt> <dd> <p>Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.</p> <p>Example: (a <= b) is true.</p> </dd> <dt>AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL</dt> <dd> <p>Logical operators.</p> </dd> </dl> <p> <i>Supported Partition Key Types</i>: The following are the supported partition keys.</p> <ul> <li> <p> <code>string</code> </p> </li> <li> <p> <code>date</code> </p> </li> <li> <p> <code>timestamp</code> </p> </li> <li> <p> <code>int</code> </p> </li> <li> <p> <code>bigint</code> </p> </li> <li> <p> <code>long</code> </p> </li> <li> <p> <code>tinyint</code> </p> </li> <li> <p> <code>smallint</code> </p> </li> <li> <p> <code>decimal</code> </p> </li> </ul> <p>If an invalid type is encountered, an exception is thrown. </p> <p>The following list shows the valid operators on each type. When you define a crawler, the <code>partitionKey</code> type is created as a <code>STRING</code>, to be compatible with the catalog partitions. </p> <p> <i>Sample API Call</i>: </p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
|
|
@ -5054,7 +5763,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, if the returned list of partitions does not does not include the last one.</p>"
|
||||
"documentation":"<p>A continuation token, if the returned list of partitions does not include the last one.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -5180,7 +5889,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -5210,7 +5919,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -5248,7 +5957,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -5287,7 +5996,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -5397,7 +6106,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the function to be retrieved is located. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -5427,7 +6136,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the functions to be retrieved are located. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -5591,6 +6300,38 @@
|
|||
"min":1,
|
||||
"pattern":"arn:aws:glue:.*"
|
||||
},
|
||||
"GlueTable":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"TableName"
|
||||
],
|
||||
"members":{
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>A database name in the AWS Glue Data Catalog.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>A table name in the AWS Glue Data Catalog.</p>"
|
||||
},
|
||||
"CatalogId":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>A unique identifier for the AWS Glue Data Catalog.</p>"
|
||||
},
|
||||
"ConnectionName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the connection to the AWS Glue Data Catalog.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The database and table in the AWS Glue Data Catalog that is used for input or output data.</p>"
|
||||
},
|
||||
"GlueTables":{
|
||||
"type":"list",
|
||||
"member":{"shape":"GlueTable"},
|
||||
"max":10,
|
||||
"min":0
|
||||
},
|
||||
"GlueVersionString":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
|
|
@ -5679,6 +6420,20 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"ImportLabelsTaskRunProperties":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"InputS3Path":{
|
||||
"shape":"UriString",
|
||||
"documentation":"<p>The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.</p>"
|
||||
},
|
||||
"Replace":{
|
||||
"shape":"ReplaceBoolean",
|
||||
"documentation":"<p>Indicates whether to overwrite your existing labels.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies configuration properties for an importing labels task run.</p>"
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"IntegerFlag":{
|
||||
"type":"integer",
|
||||
|
|
@ -5836,11 +6591,11 @@
|
|||
},
|
||||
"PreviousRunId":{
|
||||
"shape":"RunId",
|
||||
"documentation":"<p>The unique run identifier associated with the previous job run..</p>"
|
||||
"documentation":"<p>The unique run identifier associated with the previous job run.</p>"
|
||||
},
|
||||
"RunId":{
|
||||
"shape":"RunId",
|
||||
"documentation":"<p>The unique run identifier associated with this job run.</p>"
|
||||
"documentation":"<p>The run ID number.</p>"
|
||||
},
|
||||
"JobBookmark":{
|
||||
"shape":"JsonValue",
|
||||
|
|
@ -6137,6 +6892,17 @@
|
|||
"type":"string",
|
||||
"pattern":"arn:aws:kms:.*"
|
||||
},
|
||||
"LabelCount":{"type":"integer"},
|
||||
"LabelingSetGenerationTaskRunProperties":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"OutputS3Path":{
|
||||
"shape":"UriString",
|
||||
"documentation":"<p>The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies configuration properties for a labeling set generation task run.</p>"
|
||||
},
|
||||
"Language":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -6383,6 +7149,91 @@
|
|||
"type":"string",
|
||||
"enum":["EQUALS"]
|
||||
},
|
||||
"MLTransform":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"TransformStatusType",
|
||||
"documentation":"<p>The current status of the machine learning transform.</p>"
|
||||
},
|
||||
"CreatedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>A timestamp. The time and date that this machine learning transform was created.</p>"
|
||||
},
|
||||
"LastModifiedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>A timestamp. The last point in time when this machine learning transform was modified.</p>"
|
||||
},
|
||||
"InputRecordTables":{
|
||||
"shape":"GlueTables",
|
||||
"documentation":"<p>A list of AWS Glue table definitions used by the transform.</p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"TransformParameters",
|
||||
"documentation":"<p>A <code>TransformParameters</code> object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).</p>"
|
||||
},
|
||||
"EvaluationMetrics":{
|
||||
"shape":"EvaluationMetrics",
|
||||
"documentation":"<p>An <code>EvaluationMetrics</code> object. Evaluation metrics provide an estimate of the quality of your machine learning transform.</p>"
|
||||
},
|
||||
"LabelCount":{
|
||||
"shape":"LabelCount",
|
||||
"documentation":"<p>A count identifier for the labeling files generated by AWS Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.</p>"
|
||||
},
|
||||
"Schema":{
|
||||
"shape":"TransformSchema",
|
||||
"documentation":"<p>A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.</p>"
|
||||
},
|
||||
"Role":{
|
||||
"shape":"RoleString",
|
||||
"documentation":"<p>The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.</p>"
|
||||
},
|
||||
"MaxCapacity":{
|
||||
"shape":"NullableDouble",
|
||||
"documentation":"<p>The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>. </p> <p>When the <code>WorkerType</code> field is set to a value other than <code>Standard</code>, the <code>MaxCapacity</code> field is set automatically and becomes read-only.</p>"
|
||||
},
|
||||
"WorkerType":{
|
||||
"shape":"WorkerType",
|
||||
"documentation":"<p>The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.</p> </li> </ul>"
|
||||
},
|
||||
"NumberOfWorkers":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p>The number of workers of a defined <code>workerType</code> that are allocated when a task of the transform runs.</p>"
|
||||
},
|
||||
"Timeout":{
|
||||
"shape":"Timeout",
|
||||
"documentation":"<p>The timeout in minutes of the machine learning transform.</p>"
|
||||
},
|
||||
"MaxRetries":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p>The maximum number of times to retry after an <code>MLTaskRun</code> of the machine learning transform fails.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure for a machine learning transform.</p>"
|
||||
},
|
||||
"MLTransformNotReadyException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{
|
||||
"shape":"MessageString",
|
||||
"documentation":"<p>A message describing the problem.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The machine learning transform is not ready to run.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"MapValue":{
|
||||
"type":"map",
|
||||
"key":{"shape":"GenericString"},
|
||||
|
|
@ -6581,6 +7432,7 @@
|
|||
"max":1000,
|
||||
"min":1
|
||||
},
|
||||
"PaginationToken":{"type":"string"},
|
||||
"ParametersMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"KeyString"},
|
||||
|
|
@ -6599,11 +7451,11 @@
|
|||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database where the table in question is located.</p>"
|
||||
"documentation":"<p>The name of the catalog database in which to create the partition.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the table in question.</p>"
|
||||
"documentation":"<p>The name of the database table in which to create the partition.</p>"
|
||||
},
|
||||
"CreationTime":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -6637,7 +7489,7 @@
|
|||
},
|
||||
"ErrorDetail":{
|
||||
"shape":"ErrorDetail",
|
||||
"documentation":"<p>Details about the partition error.</p>"
|
||||
"documentation":"<p>The details about the partition error.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about a partition error.</p>"
|
||||
|
|
@ -6670,7 +7522,7 @@
|
|||
"documentation":"<p>The last time at which column statistics were computed for this partition.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure used to create and update a partion.</p>"
|
||||
"documentation":"<p>The structure used to create and update a partition.</p>"
|
||||
},
|
||||
"PartitionInputList":{
|
||||
"type":"list",
|
||||
|
|
@ -6698,6 +7550,24 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Path"}
|
||||
},
|
||||
"Permission":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ALL",
|
||||
"SELECT",
|
||||
"ALTER",
|
||||
"DROP",
|
||||
"DELETE",
|
||||
"INSERT",
|
||||
"CREATE_DATABASE",
|
||||
"CREATE_TABLE",
|
||||
"DATA_LOCATION_ACCESS"
|
||||
]
|
||||
},
|
||||
"PermissionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Permission"}
|
||||
},
|
||||
"PhysicalConnectionRequirements":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -6759,6 +7629,24 @@
|
|||
"min":0,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
},
|
||||
"PrincipalPermissions":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Principal":{
|
||||
"shape":"DataLakePrincipal",
|
||||
"documentation":"<p>The principal who is granted permissions.</p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>The permissions that are granted to the principal.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Permissions granted to a principal.</p>"
|
||||
},
|
||||
"PrincipalPermissionsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PrincipalPermissions"}
|
||||
},
|
||||
"PrincipalType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -6767,6 +7655,24 @@
|
|||
"GROUP"
|
||||
]
|
||||
},
|
||||
"PropertyPredicate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Key":{
|
||||
"shape":"ValueString",
|
||||
"documentation":"<p>The key of the property.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"ValueString",
|
||||
"documentation":"<p>The value of the property.</p>"
|
||||
},
|
||||
"Comparator":{
|
||||
"shape":"Comparator",
|
||||
"documentation":"<p>The comparator used to compare this property to others.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a property predicate.</p>"
|
||||
},
|
||||
"PublicKeysList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"GenericString"},
|
||||
|
|
@ -6778,7 +7684,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog for which to set the security configuration. If none is provided, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DataCatalogEncryptionSettings":{
|
||||
"shape":"DataCatalogEncryptionSettings",
|
||||
|
|
@ -6850,6 +7756,11 @@
|
|||
"type":"string",
|
||||
"pattern":"^[2-3]$"
|
||||
},
|
||||
"RecordsCount":{
|
||||
"type":"long",
|
||||
"box":true
|
||||
},
|
||||
"ReplaceBoolean":{"type":"boolean"},
|
||||
"ResetJobBookmarkRequest":{
|
||||
"type":"structure",
|
||||
"required":["JobName"],
|
||||
|
|
@ -6904,7 +7815,7 @@
|
|||
"documentation":"<p>The URI for accessing the resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>URIs for function resources.</p>"
|
||||
"documentation":"<p>The URIs for function resources.</p>"
|
||||
},
|
||||
"ResourceUriList":{
|
||||
"type":"list",
|
||||
|
|
@ -7034,8 +7945,68 @@
|
|||
},
|
||||
"documentation":"<p>A policy that specifies update and deletion behaviors for the crawler.</p>"
|
||||
},
|
||||
"SchemaColumn":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"ColumnNameString",
|
||||
"documentation":"<p>The name of the column.</p>"
|
||||
},
|
||||
"DataType":{
|
||||
"shape":"ColumnTypeString",
|
||||
"documentation":"<p>The type of data in the column.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A key-value pair representing a column and data type that this transform can run against. The <code>Schema</code> parameter of the <code>MLTransform</code> may contain up to 100 of these structures.</p>"
|
||||
},
|
||||
"SchemaPathString":{"type":"string"},
|
||||
"ScriptLocationString":{"type":"string"},
|
||||
"SearchPropertyPredicates":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PropertyPredicate"}
|
||||
},
|
||||
"SearchTablesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>A unique identifier, consisting of <code> <i>account_id</i>/datalake</code>.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, included if this is a continuation call.</p>"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"SearchPropertyPredicates",
|
||||
"documentation":"<p>A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.</p>"
|
||||
},
|
||||
"SearchText":{
|
||||
"shape":"ValueString",
|
||||
"documentation":"<p>A string used for a text search.</p> <p>Specifying a value in quotes filters based on an exact match to the value.</p>"
|
||||
},
|
||||
"SortCriteria":{
|
||||
"shape":"SortCriteria",
|
||||
"documentation":"<p>A list of criteria for sorting the results by a field name, in an ascending or descending order.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum number of tables to return in a single response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SearchTablesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, present if the current list segment is not the last.</p>"
|
||||
},
|
||||
"TableList":{
|
||||
"shape":"TableList",
|
||||
"documentation":"<p>A list of the requested <code>Table</code> objects. The <code>SearchTables</code> response returns only the tables that you have access to.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SecurityConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -7073,11 +8044,11 @@
|
|||
"members":{
|
||||
"SegmentNumber":{
|
||||
"shape":"NonNegativeInteger",
|
||||
"documentation":"<p>The zero-based index number of the this segment. For example, if the total number of segments is 4, SegmentNumber values will range from zero through three.</p>"
|
||||
"documentation":"<p>The zero-based index number of the segment. For example, if the total number of segments is 4, <code>SegmentNumber</code> values range from 0 through 3.</p>"
|
||||
},
|
||||
"TotalSegments":{
|
||||
"shape":"TotalSegmentsInteger",
|
||||
"documentation":"<p>The total numer of segments.</p>"
|
||||
"documentation":"<p>The total number of segments.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a non-overlapping region of a table's partitions, allowing multiple requests to be executed in parallel.</p>"
|
||||
|
|
@ -7091,14 +8062,14 @@
|
|||
},
|
||||
"SerializationLibrary":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Usually the class that implements the SerDe. An example is: <code>org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe</code>.</p>"
|
||||
"documentation":"<p>Usually the class that implements the SerDe. An example is <code>org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe</code>.</p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"ParametersMap",
|
||||
"documentation":"<p>These key-value pairs define initialization parameters for the SerDe.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a serialization/deserialization program (SerDe) which serves as an extractor and loader.</p>"
|
||||
"documentation":"<p>Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.</p>"
|
||||
},
|
||||
"SkewedInfo":{
|
||||
"type":"structure",
|
||||
|
|
@ -7116,7 +8087,34 @@
|
|||
"documentation":"<p>A mapping of skewed values to the columns that contain them.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies skewed values in a table. Skewed are ones that occur with very high frequency.</p>"
|
||||
"documentation":"<p>Specifies skewed values in a table. Skewed values are those that occur with very high frequency.</p>"
|
||||
},
|
||||
"Sort":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ASC",
|
||||
"DESC"
|
||||
]
|
||||
},
|
||||
"SortCriteria":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SortCriterion"},
|
||||
"max":1,
|
||||
"min":0
|
||||
},
|
||||
"SortCriterion":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"FieldName":{"shape":"ValueString"},
|
||||
"Sort":{"shape":"Sort"}
|
||||
}
|
||||
},
|
||||
"SortDirectionType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DESCENDING",
|
||||
"ASCENDING"
|
||||
]
|
||||
},
|
||||
"StartCrawlerRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -7148,6 +8146,62 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"StartExportLabelsTaskRunRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TransformId",
|
||||
"OutputS3Path"
|
||||
],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the machine learning transform.</p>"
|
||||
},
|
||||
"OutputS3Path":{
|
||||
"shape":"UriString",
|
||||
"documentation":"<p>The Amazon S3 path where you export the labels.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartExportLabelsTaskRunResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TaskRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier for the task run.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartImportLabelsTaskRunRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TransformId",
|
||||
"InputS3Path"
|
||||
],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the machine learning transform.</p>"
|
||||
},
|
||||
"InputS3Path":{
|
||||
"shape":"UriString",
|
||||
"documentation":"<p>The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.</p>"
|
||||
},
|
||||
"ReplaceAllLabels":{
|
||||
"shape":"ReplaceBoolean",
|
||||
"documentation":"<p>Indicates whether to overwrite your existing labels.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartImportLabelsTaskRunResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TaskRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier for the task run.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartJobRunRequest":{
|
||||
"type":"structure",
|
||||
"required":["JobName"],
|
||||
|
|
@ -7205,6 +8259,51 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"StartMLEvaluationTaskRunRequest":{
|
||||
"type":"structure",
|
||||
"required":["TransformId"],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the machine learning transform.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartMLEvaluationTaskRunResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TaskRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier associated with this run.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartMLLabelingSetGenerationTaskRunRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TransformId",
|
||||
"OutputS3Path"
|
||||
],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier of the machine learning transform.</p>"
|
||||
},
|
||||
"OutputS3Path":{
|
||||
"shape":"UriString",
|
||||
"documentation":"<p>The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartMLLabelingSetGenerationTaskRunResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TaskRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique run identifier that is associated with this task run.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartTriggerRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
|
|
@ -7301,7 +8400,7 @@
|
|||
},
|
||||
"Location":{
|
||||
"shape":"LocationString",
|
||||
"documentation":"<p>The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.</p>"
|
||||
"documentation":"<p>The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.</p>"
|
||||
},
|
||||
"InputFormat":{
|
||||
"shape":"FormatString",
|
||||
|
|
@ -7313,7 +8412,7 @@
|
|||
},
|
||||
"Compressed":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>True if the data in the table is compressed, or False if not.</p>"
|
||||
"documentation":"<p> <code>True</code> if the data in the table is compressed, or <code>False</code> if not.</p>"
|
||||
},
|
||||
"NumberOfBuckets":{
|
||||
"shape":"Integer",
|
||||
|
|
@ -7321,7 +8420,7 @@
|
|||
},
|
||||
"SerdeInfo":{
|
||||
"shape":"SerDeInfo",
|
||||
"documentation":"<p>Serialization/deserialization (SerDe) information.</p>"
|
||||
"documentation":"<p>The serialization/deserialization (SerDe) information.</p>"
|
||||
},
|
||||
"BucketColumns":{
|
||||
"shape":"NameStringList",
|
||||
|
|
@ -7333,15 +8432,15 @@
|
|||
},
|
||||
"Parameters":{
|
||||
"shape":"ParametersMap",
|
||||
"documentation":"<p>User-supplied properties in key-value form.</p>"
|
||||
"documentation":"<p>The user-supplied properties in key-value form.</p>"
|
||||
},
|
||||
"SkewedInfo":{
|
||||
"shape":"SkewedInfo",
|
||||
"documentation":"<p>Information about values that appear very frequently in a column (skewed values).</p>"
|
||||
"documentation":"<p>The information about values that appear frequently in a column (skewed values).</p>"
|
||||
},
|
||||
"StoredAsSubDirectories":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>True if the table data is stored in subdirectories, or False if not.</p>"
|
||||
"documentation":"<p> <code>True</code> if the table data is stored in subdirectories, or <code>False</code> if not.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes the physical storage of table data.</p>"
|
||||
|
|
@ -7356,39 +8455,39 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Name of the table. For Hive compatibility, this must be entirely lowercase.</p>"
|
||||
"documentation":"<p>The table name. For Hive compatibility, this must be entirely lowercase.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.</p>"
|
||||
"documentation":"<p>The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>Description of the table.</p>"
|
||||
"documentation":"<p>A description of the table.</p>"
|
||||
},
|
||||
"Owner":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Owner of the table.</p>"
|
||||
"documentation":"<p>The owner of the table.</p>"
|
||||
},
|
||||
"CreateTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Time when the table definition was created in the Data Catalog.</p>"
|
||||
"documentation":"<p>The time when the table definition was created in the Data Catalog.</p>"
|
||||
},
|
||||
"UpdateTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Last time the table was updated.</p>"
|
||||
"documentation":"<p>The last time that the table was updated.</p>"
|
||||
},
|
||||
"LastAccessTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Last time the table was accessed. This is usually taken from HDFS, and may not be reliable.</p>"
|
||||
"documentation":"<p>The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.</p>"
|
||||
},
|
||||
"LastAnalyzedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Last time column statistics were computed for this table.</p>"
|
||||
"documentation":"<p>The last time that column statistics were computed for this table.</p>"
|
||||
},
|
||||
"Retention":{
|
||||
"shape":"NonNegativeInteger",
|
||||
"documentation":"<p>Retention time for this table.</p>"
|
||||
"documentation":"<p>The retention time for this table.</p>"
|
||||
},
|
||||
"StorageDescriptor":{
|
||||
"shape":"StorageDescriptor",
|
||||
|
|
@ -7396,7 +8495,7 @@
|
|||
},
|
||||
"PartitionKeys":{
|
||||
"shape":"ColumnList",
|
||||
"documentation":"<p>A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.</p> <p>When creating a table used by Athena, and you do not specify any <code>partitionKeys</code>, you must at least set the value of <code>partitionKeys</code> to an empty list. For example:</p> <p> <code>\"PartitionKeys\": []</code> </p>"
|
||||
"documentation":"<p>A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.</p> <p>When you create a table used by Amazon Athena, and you do not specify any <code>partitionKeys</code>, you must at least set the value of <code>partitionKeys</code> to an empty list. For example:</p> <p> <code>\"PartitionKeys\": []</code> </p>"
|
||||
},
|
||||
"ViewOriginalText":{
|
||||
"shape":"ViewTextString",
|
||||
|
|
@ -7416,7 +8515,11 @@
|
|||
},
|
||||
"CreatedBy":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Person or entity who created the table.</p>"
|
||||
"documentation":"<p>The person or entity who created the table.</p>"
|
||||
},
|
||||
"IsRegisteredWithLakeFormation":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether the table has been registered with AWS Lake Formation.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a collection of related data organized in columns and rows.</p>"
|
||||
|
|
@ -7426,11 +8529,11 @@
|
|||
"members":{
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Name of the table. For Hive compatibility, this must be entirely lowercase.</p>"
|
||||
"documentation":"<p>The name of the table. For Hive compatibility, this must be entirely lowercase.</p>"
|
||||
},
|
||||
"ErrorDetail":{
|
||||
"shape":"ErrorDetail",
|
||||
"documentation":"<p>Detail about the error.</p>"
|
||||
"documentation":"<p>The details about the error.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An error record for table operations.</p>"
|
||||
|
|
@ -7445,27 +8548,27 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Name of the table. For Hive compatibility, this is folded to lowercase when it is stored.</p>"
|
||||
"documentation":"<p>The table name. For Hive compatibility, this is folded to lowercase when it is stored.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>Description of the table.</p>"
|
||||
"documentation":"<p>A description of the table.</p>"
|
||||
},
|
||||
"Owner":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Owner of the table.</p>"
|
||||
"documentation":"<p>The table owner.</p>"
|
||||
},
|
||||
"LastAccessTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Last time the table was accessed.</p>"
|
||||
"documentation":"<p>The last time that the table was accessed.</p>"
|
||||
},
|
||||
"LastAnalyzedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Last time column statistics were computed for this table.</p>"
|
||||
"documentation":"<p>The last time that column statistics were computed for this table.</p>"
|
||||
},
|
||||
"Retention":{
|
||||
"shape":"NonNegativeInteger",
|
||||
"documentation":"<p>Retention time for this table.</p>"
|
||||
"documentation":"<p>The retention time for this table.</p>"
|
||||
},
|
||||
"StorageDescriptor":{
|
||||
"shape":"StorageDescriptor",
|
||||
|
|
@ -7473,7 +8576,7 @@
|
|||
},
|
||||
"PartitionKeys":{
|
||||
"shape":"ColumnList",
|
||||
"documentation":"<p>A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.</p> <p>When creating a table used by Athena, and you do not specify any <code>partitionKeys</code>, you must at least set the value of <code>partitionKeys</code> to an empty list. For example:</p> <p> <code>\"PartitionKeys\": []</code> </p>"
|
||||
"documentation":"<p>A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.</p> <p>When you create a table used by Amazon Athena, and you do not specify any <code>partitionKeys</code>, you must at least set the value of <code>partitionKeys</code> to an empty list. For example:</p> <p> <code>\"PartitionKeys\": []</code> </p>"
|
||||
},
|
||||
"ViewOriginalText":{
|
||||
"shape":"ViewTextString",
|
||||
|
|
@ -7492,7 +8595,7 @@
|
|||
"documentation":"<p>These key-value pairs define properties associated with the table.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Structure used to create or update the table.</p>"
|
||||
"documentation":"<p>A structure used to define a table.</p>"
|
||||
},
|
||||
"TableList":{
|
||||
"type":"list",
|
||||
|
|
@ -7513,7 +8616,7 @@
|
|||
"members":{
|
||||
"Table":{
|
||||
"shape":"Table",
|
||||
"documentation":"<p>The table in question</p>"
|
||||
"documentation":"<p>The table in question.</p>"
|
||||
},
|
||||
"VersionId":{
|
||||
"shape":"VersionString",
|
||||
|
|
@ -7535,7 +8638,7 @@
|
|||
},
|
||||
"ErrorDetail":{
|
||||
"shape":"ErrorDetail",
|
||||
"documentation":"<p>Detail about the error.</p>"
|
||||
"documentation":"<p>The details about the error.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An error record for table-version operations.</p>"
|
||||
|
|
@ -7589,6 +8692,152 @@
|
|||
"max":50,
|
||||
"min":0
|
||||
},
|
||||
"TaskRun":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier for the transform.</p>"
|
||||
},
|
||||
"TaskRunId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier for this task run.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"TaskStatusType",
|
||||
"documentation":"<p>The current status of the requested task run.</p>"
|
||||
},
|
||||
"LogGroupName":{
|
||||
"shape":"GenericString",
|
||||
"documentation":"<p>The names of the log group for secure logging, associated with this task run.</p>"
|
||||
},
|
||||
"Properties":{
|
||||
"shape":"TaskRunProperties",
|
||||
"documentation":"<p>Specifies configuration properties associated with this task run.</p>"
|
||||
},
|
||||
"ErrorString":{
|
||||
"shape":"GenericString",
|
||||
"documentation":"<p>The list of error strings associated with this task run.</p>"
|
||||
},
|
||||
"StartedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time that this task run started.</p>"
|
||||
},
|
||||
"LastModifiedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The last point in time that the requested task run was updated.</p>"
|
||||
},
|
||||
"CompletedOn":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The last point in time that the requested task run was completed.</p>"
|
||||
},
|
||||
"ExecutionTime":{
|
||||
"shape":"ExecutionTime",
|
||||
"documentation":"<p>The amount of time (in seconds) that the task run consumed resources.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The sampling parameters that are associated with the machine learning transform.</p>"
|
||||
},
|
||||
"TaskRunFilterCriteria":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TaskRunType":{
|
||||
"shape":"TaskType",
|
||||
"documentation":"<p>The type of task run.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"TaskStatusType",
|
||||
"documentation":"<p>The current status of the task run.</p>"
|
||||
},
|
||||
"StartedBefore":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Filter on task runs started before this date.</p>"
|
||||
},
|
||||
"StartedAfter":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Filter on task runs started after this date.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The criteria that are used to filter the task runs for the machine learning transform.</p>"
|
||||
},
|
||||
"TaskRunList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TaskRun"}
|
||||
},
|
||||
"TaskRunProperties":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TaskType":{
|
||||
"shape":"TaskType",
|
||||
"documentation":"<p>The type of task run.</p>"
|
||||
},
|
||||
"ImportLabelsTaskRunProperties":{
|
||||
"shape":"ImportLabelsTaskRunProperties",
|
||||
"documentation":"<p>The configuration properties for an importing labels task run.</p>"
|
||||
},
|
||||
"ExportLabelsTaskRunProperties":{
|
||||
"shape":"ExportLabelsTaskRunProperties",
|
||||
"documentation":"<p>The configuration properties for an exporting labels task run.</p>"
|
||||
},
|
||||
"LabelingSetGenerationTaskRunProperties":{
|
||||
"shape":"LabelingSetGenerationTaskRunProperties",
|
||||
"documentation":"<p>The configuration properties for a labeling set generation task run.</p>"
|
||||
},
|
||||
"FindMatchesTaskRunProperties":{
|
||||
"shape":"FindMatchesTaskRunProperties",
|
||||
"documentation":"<p>The configuration properties for a find matches task run.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration properties for the task run.</p>"
|
||||
},
|
||||
"TaskRunSortColumnType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"TASK_RUN_TYPE",
|
||||
"STATUS",
|
||||
"STARTED"
|
||||
]
|
||||
},
|
||||
"TaskRunSortCriteria":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Column",
|
||||
"SortDirection"
|
||||
],
|
||||
"members":{
|
||||
"Column":{
|
||||
"shape":"TaskRunSortColumnType",
|
||||
"documentation":"<p>The column to be used to sort the list of task runs for the machine learning transform.</p>"
|
||||
},
|
||||
"SortDirection":{
|
||||
"shape":"SortDirectionType",
|
||||
"documentation":"<p>The sort direction to be used to sort the list of task runs for the machine learning transform.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The sorting criteria that are used to sort the list of task runs for the machine learning transform.</p>"
|
||||
},
|
||||
"TaskStatusType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"STARTING",
|
||||
"RUNNING",
|
||||
"STOPPING",
|
||||
"STOPPED",
|
||||
"SUCCEEDED",
|
||||
"FAILED",
|
||||
"TIMEOUT"
|
||||
]
|
||||
},
|
||||
"TaskType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"EVALUATION",
|
||||
"LABELING_SET_GENERATION",
|
||||
"IMPORT_LABELS",
|
||||
"EXPORT_LABELS",
|
||||
"FIND_MATCHES"
|
||||
]
|
||||
},
|
||||
"Timeout":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
|
|
@ -7602,6 +8851,108 @@
|
|||
"max":10,
|
||||
"min":1
|
||||
},
|
||||
"TransformFilterCriteria":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>A unique transform name that is used to filter the machine learning transforms.</p>"
|
||||
},
|
||||
"TransformType":{
|
||||
"shape":"TransformType",
|
||||
"documentation":"<p>The type of machine learning transform that is used to filter the machine learning transforms.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"TransformStatusType",
|
||||
"documentation":"<p>Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of \"NOT_READY\", \"READY\", or \"DELETING\".</p>"
|
||||
},
|
||||
"CreatedBefore":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time and date before which the transforms were created.</p>"
|
||||
},
|
||||
"CreatedAfter":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time and date after which the transforms were created.</p>"
|
||||
},
|
||||
"LastModifiedBefore":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Filter on transforms last modified before this date.</p>"
|
||||
},
|
||||
"LastModifiedAfter":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Filter on transforms last modified after this date.</p>"
|
||||
},
|
||||
"Schema":{
|
||||
"shape":"TransformSchema",
|
||||
"documentation":"<p>Filters on datasets with a specific schema. The <code>Map<Column, Type></code> object is an array of key-value pairs representing the schema this transform accepts, where <code>Column</code> is the name of a column, and <code>Type</code> is the type of the data such as an integer or string. Has an upper bound of 100 columns.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The criteria used to filter the machine learning transforms.</p>"
|
||||
},
|
||||
"TransformList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"MLTransform"}
|
||||
},
|
||||
"TransformParameters":{
|
||||
"type":"structure",
|
||||
"required":["TransformType"],
|
||||
"members":{
|
||||
"TransformType":{
|
||||
"shape":"TransformType",
|
||||
"documentation":"<p>The type of machine learning transform.</p> <p>For information about the types of machine learning transforms, see <a href=\"http://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html\">Creating Machine Learning Transforms</a>.</p>"
|
||||
},
|
||||
"FindMatchesParameters":{
|
||||
"shape":"FindMatchesParameters",
|
||||
"documentation":"<p>The parameters for the find matches algorithm.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The algorithm-specific parameters that are associated with the machine learning transform.</p>"
|
||||
},
|
||||
"TransformSchema":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SchemaColumn"},
|
||||
"max":100
|
||||
},
|
||||
"TransformSortColumnType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NAME",
|
||||
"TRANSFORM_TYPE",
|
||||
"STATUS",
|
||||
"CREATED",
|
||||
"LAST_MODIFIED"
|
||||
]
|
||||
},
|
||||
"TransformSortCriteria":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Column",
|
||||
"SortDirection"
|
||||
],
|
||||
"members":{
|
||||
"Column":{
|
||||
"shape":"TransformSortColumnType",
|
||||
"documentation":"<p>The column to be used in the sorting criteria that are associated with the machine learning transform.</p>"
|
||||
},
|
||||
"SortDirection":{
|
||||
"shape":"SortDirectionType",
|
||||
"documentation":"<p>The sort direction to be used in the sorting criteria that are associated with the machine learning transform.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The sorting criteria that are associated with the machine learning transform.</p>"
|
||||
},
|
||||
"TransformStatusType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NOT_READY",
|
||||
"READY",
|
||||
"DELETING"
|
||||
]
|
||||
},
|
||||
"TransformType":{
|
||||
"type":"string",
|
||||
"enum":["FIND_MATCHES"]
|
||||
},
|
||||
"Trigger":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -7914,7 +9265,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which the metadata database resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog in which the metadata database resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -8038,6 +9389,61 @@
|
|||
},
|
||||
"documentation":"<p>Specifies a JSON classifier to be updated.</p>"
|
||||
},
|
||||
"UpdateMLTransformRequest":{
|
||||
"type":"structure",
|
||||
"required":["TransformId"],
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>A unique identifier that was generated when the transform was created.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The unique name that you gave the transform when you created it.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>A description of the transform. The default is an empty string.</p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"TransformParameters",
|
||||
"documentation":"<p>The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.</p>"
|
||||
},
|
||||
"Role":{
|
||||
"shape":"RoleString",
|
||||
"documentation":"<p>The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.</p>"
|
||||
},
|
||||
"MaxCapacity":{
|
||||
"shape":"NullableDouble",
|
||||
"documentation":"<p>The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>. </p> <p>When the <code>WorkerType</code> field is set to a value other than <code>Standard</code>, the <code>MaxCapacity</code> field is set automatically and becomes read-only.</p>"
|
||||
},
|
||||
"WorkerType":{
|
||||
"shape":"WorkerType",
|
||||
"documentation":"<p>The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.</p> </li> </ul>"
|
||||
},
|
||||
"NumberOfWorkers":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p>The number of workers of a defined <code>workerType</code> that are allocated when this task runs.</p>"
|
||||
},
|
||||
"Timeout":{
|
||||
"shape":"Timeout",
|
||||
"documentation":"<p>The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>"
|
||||
},
|
||||
"MaxRetries":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p>The maximum number of times to retry a task for this transform after a task run fails.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateMLTransformResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TransformId":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The unique identifier for the transform that was updated.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdatePartitionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -8049,7 +9455,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partition to be updated resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the partition to be updated resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -8057,7 +9463,7 @@
|
|||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the table where the partition to be updated is located.</p>"
|
||||
"documentation":"<p>The name of the table in which the partition to be updated is located.</p>"
|
||||
},
|
||||
"PartitionValueList":{
|
||||
"shape":"BoundedPartitionValueList",
|
||||
|
|
@ -8065,7 +9471,7 @@
|
|||
},
|
||||
"PartitionInput":{
|
||||
"shape":"PartitionInput",
|
||||
"documentation":"<p>The new partition object to which to update the partition.</p>"
|
||||
"documentation":"<p>The new partition object to update the partition to.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -8083,7 +9489,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -8095,7 +9501,7 @@
|
|||
},
|
||||
"SkipArchive":{
|
||||
"shape":"BooleanNullable",
|
||||
"documentation":"<p>By default, <code>UpdateTable</code> always creates an archived version of the table before updating it. If <code>skipArchive</code> is set to true, however, <code>UpdateTable</code> does not create the archived version.</p>"
|
||||
"documentation":"<p>By default, <code>UpdateTable</code> always creates an archived version of the table before updating it. However, if <code>skipArchive</code> is set to true, <code>UpdateTable</code> does not create the archived version.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -8140,7 +9546,7 @@
|
|||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the function to be updated is located. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
"documentation":"<p>The ID of the Data Catalog where the function to be updated is located. If none is provided, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -8152,7 +9558,7 @@
|
|||
},
|
||||
"FunctionInput":{
|
||||
"shape":"UserDefinedFunctionInput",
|
||||
"documentation":"<p>A <code>FunctionInput</code> object that re-defines the function in the Data Catalog.</p>"
|
||||
"documentation":"<p>A <code>FunctionInput</code> object that redefines the function in the Data Catalog.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -8262,7 +9668,7 @@
|
|||
"documentation":"<p>The resource URIs for the function.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure used to create or updata a user-defined function.</p>"
|
||||
"documentation":"<p>A structure used to create or update a user-defined function.</p>"
|
||||
},
|
||||
"UserDefinedFunctionList":{
|
||||
"type":"list",
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
{"shape":"BadRequestException"},
|
||||
{"shape":"InternalServerErrorException"}
|
||||
],
|
||||
"documentation":"<p>Archives Amazon GuardDuty findings specified by the list of finding IDs.</p>"
|
||||
"documentation":"<p>Archives GuardDuty findings specified by the list of finding IDs.</p> <note> <p>Only the master account can archive findings. Member accounts do not have permission to archive findings from their accounts.</p> </note>"
|
||||
},
|
||||
"CreateDetector":{
|
||||
"name":"CreateDetector",
|
||||
|
|
@ -55,7 +55,7 @@
|
|||
{"shape":"BadRequestException"},
|
||||
{"shape":"InternalServerErrorException"}
|
||||
],
|
||||
"documentation":"<p>Creates a single Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector must be created in order for GuardDuty to become operational.</p>"
|
||||
"documentation":"<p>Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each region that you enable the service. You can have only one detector per account per region.</p>"
|
||||
},
|
||||
"CreateFilter":{
|
||||
"name":"CreateFilter",
|
||||
|
|
@ -370,7 +370,7 @@
|
|||
{"shape":"BadRequestException"},
|
||||
{"shape":"InternalServerErrorException"}
|
||||
],
|
||||
"documentation":"<p>Provides the details for the GuardDuty master account to the current GuardDuty member account.</p>"
|
||||
"documentation":"<p>Provides the details for the GuardDuty master account associated with the current GuardDuty member account.</p>"
|
||||
},
|
||||
"GetMembers":{
|
||||
"name":"GetMembers",
|
||||
|
|
@ -743,7 +743,8 @@
|
|||
"documentation":"<p>The type of the user.</p>",
|
||||
"locationName":"userType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the access keys.</p>"
|
||||
},
|
||||
"AccountDetail":{
|
||||
"type":"structure",
|
||||
|
|
@ -762,7 +763,8 @@
|
|||
"documentation":"<p>Member account's email address.</p>",
|
||||
"locationName":"email"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the account.</p>"
|
||||
},
|
||||
"AccountDetails":{
|
||||
"type":"list",
|
||||
|
|
@ -809,7 +811,8 @@
|
|||
"documentation":"<p>Information about the PORT_PROBE action described in this finding.</p>",
|
||||
"locationName":"portProbeAction"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about action.</p>"
|
||||
},
|
||||
"ArchiveFindingsRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -864,7 +867,8 @@
|
|||
"documentation":"<p>AWS service name whose API was invoked.</p>",
|
||||
"locationName":"serviceName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the API operation.</p>"
|
||||
},
|
||||
"BadRequestException":{
|
||||
"type":"structure",
|
||||
|
|
@ -893,7 +897,8 @@
|
|||
"documentation":"<p>City name of the remote IP address.</p>",
|
||||
"locationName":"cityName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the city associated with the IP address.</p>"
|
||||
},
|
||||
"ClientToken":{
|
||||
"type":"string",
|
||||
|
|
@ -905,46 +910,48 @@
|
|||
"members":{
|
||||
"Eq":{
|
||||
"shape":"Eq",
|
||||
"documentation":"<p>Represents the equal condition to be applied to a single field when querying for findings.</p>",
|
||||
"documentation":"<p>Deprecated. Represents the equal condition to be applied to a single field when querying for findings.</p>",
|
||||
"deprecated":true,
|
||||
"locationName":"eq"
|
||||
},
|
||||
"Neq":{
|
||||
"shape":"Neq",
|
||||
"documentation":"<p>Represents the not equal condition to be applied to a single field when querying for findings.</p>",
|
||||
"documentation":"<p>Deprecated. Represents the not equal condition to be applied to a single field when querying for findings.</p>",
|
||||
"deprecated":true,
|
||||
"locationName":"neq"
|
||||
},
|
||||
"Gt":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>Represents a greater than condition to be applied to a single field when querying for findings.</p>",
|
||||
"documentation":"<p>Deprecated. Represents a greater than condition to be applied to a single field when querying for findings.</p>",
|
||||
"deprecated":true,
|
||||
"locationName":"gt"
|
||||
},
|
||||
"Gte":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>Represents a greater than equal condition to be applied to a single field when querying for findings.</p>",
|
||||
"documentation":"<p>Deprecated. Represents a greater than equal condition to be applied to a single field when querying for findings.</p>",
|
||||
"deprecated":true,
|
||||
"locationName":"gte"
|
||||
},
|
||||
"Lt":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>Represents a less than condition to be applied to a single field when querying for findings.</p>",
|
||||
"documentation":"<p>Deprecated. Represents a less than condition to be applied to a single field when querying for findings.</p>",
|
||||
"deprecated":true,
|
||||
"locationName":"lt"
|
||||
},
|
||||
"Lte":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>Represents a less than equal condition to be applied to a single field when querying for findings.</p>",
|
||||
"documentation":"<p>Deprecated. Represents a less than equal condition to be applied to a single field when querying for findings.</p>",
|
||||
"deprecated":true,
|
||||
"locationName":"lte"
|
||||
},
|
||||
"Equals":{
|
||||
"shape":"Equals",
|
||||
"documentation":"<p>Represents an <b>equal</b> condition to be applied to a single field when querying for findings.</p>",
|
||||
"locationName":"equals"
|
||||
},
|
||||
"NotEquals":{
|
||||
"shape":"NotEquals",
|
||||
"documentation":"<p>Represents an <b>not equal</b> condition to be applied to a single field when querying for findings.</p>",
|
||||
"locationName":"notEquals"
|
||||
},
|
||||
"GreaterThan":{
|
||||
|
|
@ -967,7 +974,8 @@
|
|||
"documentation":"<p>Represents a less than equal condition to be applied to a single field when querying for findings.</p>",
|
||||
"locationName":"lessThanOrEqual"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the condition.</p>"
|
||||
},
|
||||
"CountBySeverity":{
|
||||
"type":"map",
|
||||
|
|
@ -987,7 +995,8 @@
|
|||
"documentation":"<p>Country name of the remote IP address.</p>",
|
||||
"locationName":"countryName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the country.</p>"
|
||||
},
|
||||
"CreateDetectorRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1406,7 +1415,7 @@
|
|||
"members":{
|
||||
"UnprocessedAccounts":{
|
||||
"shape":"UnprocessedAccounts",
|
||||
"documentation":"<p>A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.</p>",
|
||||
"documentation":"<p>The accounts that could not be processed.</p>",
|
||||
"locationName":"unprocessedAccounts"
|
||||
}
|
||||
}
|
||||
|
|
@ -1513,7 +1522,8 @@
|
|||
"documentation":"<p>Domain information for the DNS request.</p>",
|
||||
"locationName":"domain"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the DNS request.</p>"
|
||||
},
|
||||
"DomainDetails":{
|
||||
"type":"structure",
|
||||
|
|
@ -1523,7 +1533,8 @@
|
|||
"documentation":"<p>Domain information for the AWS API call.</p>",
|
||||
"locationName":"domain"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the domain.</p>"
|
||||
},
|
||||
"Double":{"type":"double"},
|
||||
"Email":{
|
||||
|
|
@ -1539,6 +1550,17 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"Evidence":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThreatIntelligenceDetails":{
|
||||
"shape":"ThreatIntelligenceDetails",
|
||||
"documentation":"<p>A list of threat intelligence details related to the evidence.</p>",
|
||||
"locationName":"threatIntelligenceDetails"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the reason that the finding was generated.</p>"
|
||||
},
|
||||
"Feedback":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -1593,80 +1615,79 @@
|
|||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>AWS account ID where the activity occurred that prompted GuardDuty to generate a finding.</p>",
|
||||
"documentation":"<p>The ID of the account in which the finding was generated.</p>",
|
||||
"locationName":"accountId"
|
||||
},
|
||||
"Arn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ARN of a finding described by the action.</p>",
|
||||
"documentation":"<p>The ARN for the finding.</p>",
|
||||
"locationName":"arn"
|
||||
},
|
||||
"Confidence":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>The confidence level of a finding.</p>",
|
||||
"documentation":"<p>The confidence score for the finding.</p>",
|
||||
"locationName":"confidence"
|
||||
},
|
||||
"CreatedAt":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The time stamp at which a finding was generated.</p>",
|
||||
"documentation":"<p>The time and date at which the finding was created.</p>",
|
||||
"locationName":"createdAt"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The description of a finding.</p>",
|
||||
"documentation":"<p>The description of the finding.</p>",
|
||||
"locationName":"description"
|
||||
},
|
||||
"Id":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier that corresponds to a finding described by the action.</p>",
|
||||
"documentation":"<p>The ID of the finding.</p>",
|
||||
"locationName":"id"
|
||||
},
|
||||
"Partition":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS resource partition.</p>",
|
||||
"documentation":"<p>The partition associated with the finding.</p>",
|
||||
"locationName":"partition"
|
||||
},
|
||||
"Region":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS region where the activity occurred that prompted GuardDuty to generate a finding.</p>",
|
||||
"documentation":"<p>The Region in which the finding was generated.</p>",
|
||||
"locationName":"region"
|
||||
},
|
||||
"Resource":{
|
||||
"shape":"Resource",
|
||||
"documentation":"<p>The AWS resource associated with the activity that prompted GuardDuty to generate a finding.</p>",
|
||||
"locationName":"resource"
|
||||
},
|
||||
"SchemaVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Findings' schema version.</p>",
|
||||
"documentation":"<p>The version of the schema used for the finding.</p>",
|
||||
"locationName":"schemaVersion"
|
||||
},
|
||||
"Service":{
|
||||
"shape":"Service",
|
||||
"documentation":"<p>Additional information assigned to the generated finding by GuardDuty.</p>",
|
||||
"locationName":"service"
|
||||
},
|
||||
"Severity":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>The severity of a finding.</p>",
|
||||
"documentation":"<p>The severity of the finding.</p>",
|
||||
"locationName":"severity"
|
||||
},
|
||||
"Title":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The title of a finding.</p>",
|
||||
"documentation":"<p>The title for the finding.</p>",
|
||||
"locationName":"title"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"FindingType",
|
||||
"documentation":"<p>The type of a finding described by the action.</p>",
|
||||
"documentation":"<p>The type of the finding.</p>",
|
||||
"locationName":"type"
|
||||
},
|
||||
"UpdatedAt":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The time stamp at which a finding was last updated.</p>",
|
||||
"documentation":"<p>The time and date at which the finding was laste updated.</p>",
|
||||
"locationName":"updatedAt"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the finding.</p>"
|
||||
},
|
||||
"FindingCriteria":{
|
||||
"type":"structure",
|
||||
|
|
@ -1676,7 +1697,8 @@
|
|||
"documentation":"<p>Represents a map of finding properties that match specified conditions and values when querying findings.</p>",
|
||||
"locationName":"criterion"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains finding criteria information.</p>"
|
||||
},
|
||||
"FindingId":{
|
||||
"type":"string",
|
||||
|
|
@ -1715,7 +1737,8 @@
|
|||
"documentation":"<p>Represents a map of severity to count statistic for a set of findings</p>",
|
||||
"locationName":"countBySeverity"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about finding statistics.</p>"
|
||||
},
|
||||
"FindingType":{
|
||||
"type":"string",
|
||||
|
|
@ -1747,7 +1770,8 @@
|
|||
"documentation":"<p>Longitude information of remote IP address.</p>",
|
||||
"locationName":"lon"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the </p>"
|
||||
},
|
||||
"GetDetectorRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2141,7 +2165,8 @@
|
|||
"documentation":"<p>AWS EC2 instance profile ID.</p>",
|
||||
"locationName":"id"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the instance profile.</p>"
|
||||
},
|
||||
"InstanceDetails":{
|
||||
"type":"structure",
|
||||
|
|
@ -2206,7 +2231,8 @@
|
|||
"documentation":"<p>The tags of the EC2 instance.</p>",
|
||||
"locationName":"tags"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the details of an instance.</p>"
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InternalServerErrorException":{
|
||||
|
|
@ -2250,7 +2276,8 @@
|
|||
"documentation":"<p>Timestamp at which the invitation was sent</p>",
|
||||
"locationName":"invitedAt"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the invitation.</p>"
|
||||
},
|
||||
"Invitations":{
|
||||
"type":"list",
|
||||
|
|
@ -2591,6 +2618,7 @@
|
|||
"members":{
|
||||
"Tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p>The tags associated with the resource.</p>",
|
||||
"locationName":"tags"
|
||||
}
|
||||
}
|
||||
|
|
@ -2648,7 +2676,8 @@
|
|||
"documentation":"<p>Port name of the local connection.</p>",
|
||||
"locationName":"portName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the port for the local connection.</p>"
|
||||
},
|
||||
"Location":{
|
||||
"type":"string",
|
||||
|
|
@ -2661,7 +2690,7 @@
|
|||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>Master account ID</p>",
|
||||
"documentation":"<p>The ID of the account used as the Master account.</p>",
|
||||
"locationName":"accountId"
|
||||
},
|
||||
"InvitationId":{
|
||||
|
|
@ -2676,10 +2705,11 @@
|
|||
},
|
||||
"InvitedAt":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Timestamp at which the invitation was sent</p>",
|
||||
"documentation":"<p>Timestamp at which the invitation was sent.</p>",
|
||||
"locationName":"invitedAt"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the Master account and invitation.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
|
|
@ -2731,7 +2761,8 @@
|
|||
"documentation":"<p>Member last updated timestamp.</p>",
|
||||
"locationName":"updatedAt"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Continas information about the member account </p>"
|
||||
},
|
||||
"Members":{
|
||||
"type":"list",
|
||||
|
|
@ -2781,7 +2812,8 @@
|
|||
"documentation":"<p>Remote port information of the connection.</p>",
|
||||
"locationName":"remotePortDetails"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the network connection.</p>"
|
||||
},
|
||||
"NetworkInterface":{
|
||||
"type":"structure",
|
||||
|
|
@ -2836,7 +2868,8 @@
|
|||
"documentation":"<p>The VPC ID of the EC2 instance.</p>",
|
||||
"locationName":"vpcId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the network interface.</p>"
|
||||
},
|
||||
"NetworkInterfaces":{
|
||||
"type":"list",
|
||||
|
|
@ -2876,7 +2909,8 @@
|
|||
"documentation":"<p>Name of the internet provider.</p>",
|
||||
"locationName":"org"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Continas information about the organization.</p>"
|
||||
},
|
||||
"PortProbeAction":{
|
||||
"type":"structure",
|
||||
|
|
@ -2891,7 +2925,8 @@
|
|||
"documentation":"<p>A list of port probe details objects.</p>",
|
||||
"locationName":"portProbeDetails"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the port probe.</p>"
|
||||
},
|
||||
"PortProbeDetail":{
|
||||
"type":"structure",
|
||||
|
|
@ -2906,7 +2941,8 @@
|
|||
"documentation":"<p>Remote IP information of the connection.</p>",
|
||||
"locationName":"remoteIpDetails"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the port probe details.</p>"
|
||||
},
|
||||
"PortProbeDetails":{
|
||||
"type":"list",
|
||||
|
|
@ -2925,7 +2961,8 @@
|
|||
"documentation":"<p>Private IP address of the EC2 instance.</p>",
|
||||
"locationName":"privateIpAddress"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the private IP address.</p>"
|
||||
},
|
||||
"PrivateIpAddresses":{
|
||||
"type":"list",
|
||||
|
|
@ -2944,7 +2981,8 @@
|
|||
"documentation":"<p>Product code type.</p>",
|
||||
"locationName":"productType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the product code.</p>"
|
||||
},
|
||||
"ProductCodes":{
|
||||
"type":"list",
|
||||
|
|
@ -2978,7 +3016,8 @@
|
|||
"documentation":"<p>ISP Organization information of the remote IP address.</p>",
|
||||
"locationName":"organization"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Continas information about the remote IP address.</p>"
|
||||
},
|
||||
"RemotePortDetails":{
|
||||
"type":"structure",
|
||||
|
|
@ -2993,7 +3032,8 @@
|
|||
"documentation":"<p>Port name of the remote connection.</p>",
|
||||
"locationName":"portName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the remote port.</p>"
|
||||
},
|
||||
"Resource":{
|
||||
"type":"structure",
|
||||
|
|
@ -3013,7 +3053,8 @@
|
|||
"documentation":"<p>The type of the AWS resource.</p>",
|
||||
"locationName":"resourceType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the resource.</p>"
|
||||
},
|
||||
"SecurityGroup":{
|
||||
"type":"structure",
|
||||
|
|
@ -3028,7 +3069,8 @@
|
|||
"documentation":"<p>EC2 instance's security group name.</p>",
|
||||
"locationName":"groupName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the security group.</p>"
|
||||
},
|
||||
"SecurityGroups":{
|
||||
"type":"list",
|
||||
|
|
@ -3042,6 +3084,11 @@
|
|||
"documentation":"<p>Information about the activity described in a finding.</p>",
|
||||
"locationName":"action"
|
||||
},
|
||||
"Evidence":{
|
||||
"shape":"Evidence",
|
||||
"documentation":"<p>An evidence object associated with the service.</p>",
|
||||
"locationName":"evidence"
|
||||
},
|
||||
"Archived":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether this finding is archived.</p>",
|
||||
|
|
@ -3082,7 +3129,8 @@
|
|||
"documentation":"<p>Feedback left about the finding.</p>",
|
||||
"locationName":"userFeedback"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the service.</p>"
|
||||
},
|
||||
"SortCriteria":{
|
||||
"type":"structure",
|
||||
|
|
@ -3097,7 +3145,8 @@
|
|||
"documentation":"<p>Order by which the sorted findings are to be displayed.</p>",
|
||||
"locationName":"orderBy"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the criteria for sorting.</p>"
|
||||
},
|
||||
"StartMonitoringMembersRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -3175,7 +3224,8 @@
|
|||
"documentation":"<p>EC2 instance tag value.</p>",
|
||||
"locationName":"value"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the tag associated with the resource.</p>"
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
|
|
@ -3262,6 +3312,30 @@
|
|||
"max":300,
|
||||
"min":1
|
||||
},
|
||||
"ThreatIntelligenceDetail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThreatListName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the threat intelligence list that triggered the finding.</p>",
|
||||
"locationName":"threatListName"
|
||||
},
|
||||
"ThreatNames":{
|
||||
"shape":"ThreatNames",
|
||||
"documentation":"<p>A list of names of the threats in the threat intelligence list that triggered the finding.</p>",
|
||||
"locationName":"threatNames"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An instance of a threat intelligence detail that constitutes evidence for the finding.</p>"
|
||||
},
|
||||
"ThreatIntelligenceDetails":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ThreatIntelligenceDetail"}
|
||||
},
|
||||
"ThreatNames":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"UnarchiveFindingsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3304,7 +3378,8 @@
|
|||
"documentation":"<p>A reason why the account hasn't been processed.</p>",
|
||||
"locationName":"result"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the accounts that were not processed.</p>"
|
||||
},
|
||||
"UnprocessedAccounts":{
|
||||
"type":"list",
|
||||
|
|
|
|||
|
|
@ -131,7 +131,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.</p>"
|
||||
"documentation":"<p>Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.</p>"
|
||||
},
|
||||
"AttachThingPrincipal":{
|
||||
"name":"AttachThingPrincipal",
|
||||
|
|
@ -151,6 +151,22 @@
|
|||
],
|
||||
"documentation":"<p>Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.</p>"
|
||||
},
|
||||
"CancelAuditMitigationActionsTask":{
|
||||
"name":"CancelAuditMitigationActionsTask",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/audit/mitigationactions/tasks/{taskId}/cancel"
|
||||
},
|
||||
"input":{"shape":"CancelAuditMitigationActionsTaskRequest"},
|
||||
"output":{"shape":"CancelAuditMitigationActionsTaskResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.</p>"
|
||||
},
|
||||
"CancelAuditTask":{
|
||||
"name":"CancelAuditTask",
|
||||
"http":{
|
||||
|
|
@ -342,6 +358,23 @@
|
|||
],
|
||||
"documentation":"<p>Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.</p> <p> <b>Note</b> This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.</p>"
|
||||
},
|
||||
"CreateMitigationAction":{
|
||||
"name":"CreateMitigationAction",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/mitigationactions/actions/{actionName}"
|
||||
},
|
||||
"input":{"shape":"CreateMitigationActionRequest"},
|
||||
"output":{"shape":"CreateMitigationActionResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.</p>"
|
||||
},
|
||||
"CreateOTAUpdate":{
|
||||
"name":"CreateOTAUpdate",
|
||||
"http":{
|
||||
|
|
@ -430,6 +463,7 @@
|
|||
"output":{"shape":"CreateScheduledAuditResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
|
|
@ -629,7 +663,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the specified certificate.</p> <p>A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the <a>DetachPrincipalPolicy</a> API to detach all policies. Next, use the <a>UpdateCertificate</a> API to set the certificate to the INACTIVE status.</p>"
|
||||
"documentation":"<p>Deletes the specified certificate.</p> <p>A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the <a>DetachPrincipalPolicy</a> API to detach all policies. Next, use the <a>UpdateCertificate</a> API to set the certificate to the INACTIVE status.</p>"
|
||||
},
|
||||
"DeleteDynamicThingGroup":{
|
||||
"name":"DeleteDynamicThingGroup",
|
||||
|
|
@ -680,6 +714,21 @@
|
|||
],
|
||||
"documentation":"<p>Deletes a job execution.</p>"
|
||||
},
|
||||
"DeleteMitigationAction":{
|
||||
"name":"DeleteMitigationAction",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/mitigationactions/actions/{actionName}"
|
||||
},
|
||||
"input":{"shape":"DeleteMitigationActionRequest"},
|
||||
"output":{"shape":"DeleteMitigationActionResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a defined mitigation action from your AWS account.</p>"
|
||||
},
|
||||
"DeleteOTAUpdate":{
|
||||
"name":"DeleteOTAUpdate",
|
||||
"http":{
|
||||
|
|
@ -937,6 +986,38 @@
|
|||
],
|
||||
"documentation":"<p>Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.</p>"
|
||||
},
|
||||
"DescribeAuditFinding":{
|
||||
"name":"DescribeAuditFinding",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/audit/findings/{findingId}"
|
||||
},
|
||||
"input":{"shape":"DescribeAuditFindingRequest"},
|
||||
"output":{"shape":"DescribeAuditFindingResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.</p>"
|
||||
},
|
||||
"DescribeAuditMitigationActionsTask":{
|
||||
"name":"DescribeAuditMitigationActionsTask",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/audit/mitigationactions/tasks/{taskId}"
|
||||
},
|
||||
"input":{"shape":"DescribeAuditMitigationActionsTaskRequest"},
|
||||
"output":{"shape":"DescribeAuditMitigationActionsTaskResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.</p>"
|
||||
},
|
||||
"DescribeAuditTask":{
|
||||
"name":"DescribeAuditTask",
|
||||
"http":{
|
||||
|
|
@ -1121,6 +1202,22 @@
|
|||
],
|
||||
"documentation":"<p>Describes a job execution.</p>"
|
||||
},
|
||||
"DescribeMitigationAction":{
|
||||
"name":"DescribeMitigationAction",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/mitigationactions/actions/{actionName}"
|
||||
},
|
||||
"input":{"shape":"DescribeMitigationActionRequest"},
|
||||
"output":{"shape":"DescribeMitigationActionResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Gets information about a mitigation action.</p>"
|
||||
},
|
||||
"DescribeRoleAlias":{
|
||||
"name":"DescribeRoleAlias",
|
||||
"http":{
|
||||
|
|
@ -1599,6 +1696,36 @@
|
|||
],
|
||||
"documentation":"<p>Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)</p>"
|
||||
},
|
||||
"ListAuditMitigationActionsExecutions":{
|
||||
"name":"ListAuditMitigationActionsExecutions",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/audit/mitigationactions/executions"
|
||||
},
|
||||
"input":{"shape":"ListAuditMitigationActionsExecutionsRequest"},
|
||||
"output":{"shape":"ListAuditMitigationActionsExecutionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Gets the status of audit mitigation action tasks that were executed.</p>"
|
||||
},
|
||||
"ListAuditMitigationActionsTasks":{
|
||||
"name":"ListAuditMitigationActionsTasks",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/audit/mitigationactions/tasks"
|
||||
},
|
||||
"input":{"shape":"ListAuditMitigationActionsTasksRequest"},
|
||||
"output":{"shape":"ListAuditMitigationActionsTasksResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Gets a list of audit mitigation action tasks that match the specified filters.</p>"
|
||||
},
|
||||
"ListAuditTasks":{
|
||||
"name":"ListAuditTasks",
|
||||
"http":{
|
||||
|
|
@ -1763,6 +1890,21 @@
|
|||
],
|
||||
"documentation":"<p>Lists jobs.</p>"
|
||||
},
|
||||
"ListMitigationActions":{
|
||||
"name":"ListMitigationActions",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/mitigationactions/actions"
|
||||
},
|
||||
"input":{"shape":"ListMitigationActionsRequest"},
|
||||
"output":{"shape":"ListMitigationActionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Gets a list of all mitigation actions that match the specified filter criteria.</p>"
|
||||
},
|
||||
"ListOTAUpdates":{
|
||||
"name":"ListOTAUpdates",
|
||||
"http":{
|
||||
|
|
@ -2208,7 +2350,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior or thing (device).</p>"
|
||||
"documentation":"<p>Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).</p>"
|
||||
},
|
||||
"RegisterCACertificate":{
|
||||
"name":"RegisterCACertificate",
|
||||
|
|
@ -2437,6 +2579,23 @@
|
|||
],
|
||||
"documentation":"<p>Sets the logging options for the V2 logging service.</p>"
|
||||
},
|
||||
"StartAuditMitigationActionsTask":{
|
||||
"name":"StartAuditMitigationActionsTask",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/audit/mitigationactions/tasks/{taskId}"
|
||||
},
|
||||
"input":{"shape":"StartAuditMitigationActionsTaskRequest"},
|
||||
"output":{"shape":"StartAuditMitigationActionsTaskResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TaskAlreadyExistsException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Starts a task that applies a set of mitigation actions to the specified target.</p>"
|
||||
},
|
||||
"StartOnDemandAuditTask":{
|
||||
"name":"StartOnDemandAuditTask",
|
||||
"http":{
|
||||
|
|
@ -2728,6 +2887,22 @@
|
|||
],
|
||||
"documentation":"<p>Updates supported fields of the specified job.</p>"
|
||||
},
|
||||
"UpdateMitigationAction":{
|
||||
"name":"UpdateMitigationAction",
|
||||
"http":{
|
||||
"method":"PATCH",
|
||||
"requestUri":"/mitigationactions/actions/{actionName}"
|
||||
},
|
||||
"input":{"shape":"UpdateMitigationActionRequest"},
|
||||
"output":{"shape":"UpdateMitigationActionResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Updates the definition for the specified mitigation action.</p>"
|
||||
},
|
||||
"UpdateRoleAlias":{
|
||||
"name":"UpdateRoleAlias",
|
||||
"http":{
|
||||
|
|
@ -2760,7 +2935,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Updates a scheduled audit, including what checks are performed and how often the audit takes place.</p>"
|
||||
"documentation":"<p>Updates a scheduled audit, including which checks are performed and how often the audit takes place.</p>"
|
||||
},
|
||||
"UpdateSecurityProfile":{
|
||||
"name":"UpdateSecurityProfile",
|
||||
|
|
@ -3030,7 +3205,7 @@
|
|||
"documentation":"<p>The ID of the active violation.</p>"
|
||||
},
|
||||
"thingName":{
|
||||
"shape":"ThingName",
|
||||
"shape":"DeviceDefenderThingName",
|
||||
"documentation":"<p>The name of the thing responsible for the active violation.</p>"
|
||||
},
|
||||
"securityProfileName":{
|
||||
|
|
@ -3116,6 +3291,21 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"AddThingsToThingGroupParams":{
|
||||
"type":"structure",
|
||||
"required":["thingGroupNames"],
|
||||
"members":{
|
||||
"thingGroupNames":{
|
||||
"shape":"ThingGroupNames",
|
||||
"documentation":"<p>The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.</p>"
|
||||
},
|
||||
"overrideDynamicGroups":{
|
||||
"shape":"OverrideDynamicGroups",
|
||||
"documentation":"<p>Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Parameters used when defining a mitigation action that move a set of things to a thing group.</p>"
|
||||
},
|
||||
"AdditionalMetricsToRetainList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BehaviorMetric"}
|
||||
|
|
@ -3322,7 +3512,7 @@
|
|||
},
|
||||
"merge":{
|
||||
"shape":"Flag",
|
||||
"documentation":"<p>Specifies whether the list of attributes provided in the <code>AttributePayload</code> is merged with the attributes stored in the registry, instead of overwriting them.</p> <p>To remove an attribute, call <code>UpdateThing</code> with an empty attribute value.</p> <note> <p>The <code>merge</code> attribute is only valid when calling <code>UpdateThing</code>.</p> </note>"
|
||||
"documentation":"<p>Specifies whether the list of attributes provided in the <code>AttributePayload</code> is merged with the attributes stored in the registry, instead of overwriting them.</p> <p>To remove an attribute, call <code>UpdateThing</code> with an empty attribute value.</p> <note> <p>The <code>merge</code> attribute is only valid when calling <code>UpdateThing</code> or <code>UpdateThingGroup</code>.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The attribute payload.</p>"
|
||||
|
|
@ -3362,11 +3552,11 @@
|
|||
"members":{
|
||||
"checkRunStatus":{
|
||||
"shape":"AuditCheckRunStatus",
|
||||
"documentation":"<p>The completion status of this check, one of \"IN_PROGRESS\", \"WAITING_FOR_DATA_COLLECTION\", \"CANCELED\", \"COMPLETED_COMPLIANT\", \"COMPLETED_NON_COMPLIANT\", or \"FAILED\".</p>"
|
||||
"documentation":"<p>The completion status of this check. One of \"IN_PROGRESS\", \"WAITING_FOR_DATA_COLLECTION\", \"CANCELED\", \"COMPLETED_COMPLIANT\", \"COMPLETED_NON_COMPLIANT\", or \"FAILED\".</p>"
|
||||
},
|
||||
"checkCompliant":{
|
||||
"shape":"CheckCompliant",
|
||||
"documentation":"<p>True if the check completed and found all resources compliant.</p>"
|
||||
"documentation":"<p>True if the check is complete and found all resources compliant.</p>"
|
||||
},
|
||||
"totalResourcesCount":{
|
||||
"shape":"TotalResourcesCount",
|
||||
|
|
@ -3374,22 +3564,22 @@
|
|||
},
|
||||
"nonCompliantResourcesCount":{
|
||||
"shape":"NonCompliantResourcesCount",
|
||||
"documentation":"<p>The number of resources that the check found non-compliant.</p>"
|
||||
"documentation":"<p>The number of resources that were found noncompliant during the check.</p>"
|
||||
},
|
||||
"errorCode":{
|
||||
"shape":"ErrorCode",
|
||||
"documentation":"<p>The code of any error encountered when performing this check during this audit. One of \"INSUFFICIENT_PERMISSIONS\", or \"AUDIT_CHECK_DISABLED\".</p>"
|
||||
"documentation":"<p>The code of any error encountered when this check is performed during this audit. One of \"INSUFFICIENT_PERMISSIONS\" or \"AUDIT_CHECK_DISABLED\".</p>"
|
||||
},
|
||||
"message":{
|
||||
"shape":"ErrorMessage",
|
||||
"documentation":"<p>The message associated with any error encountered when performing this check during this audit.</p>"
|
||||
"documentation":"<p>The message associated with any error encountered when this check is performed during this audit.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the audit check.</p>"
|
||||
},
|
||||
"AuditCheckName":{
|
||||
"type":"string",
|
||||
"documentation":"<p>An audit check name. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
|
||||
"documentation":"<p>An audit check name. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
|
||||
},
|
||||
"AuditCheckRunStatus":{
|
||||
"type":"string",
|
||||
|
|
@ -3402,6 +3592,16 @@
|
|||
"FAILED"
|
||||
]
|
||||
},
|
||||
"AuditCheckToActionsMapping":{
|
||||
"type":"map",
|
||||
"key":{"shape":"AuditCheckName"},
|
||||
"value":{"shape":"MitigationActionNameList"}
|
||||
},
|
||||
"AuditCheckToReasonCodeFilter":{
|
||||
"type":"map",
|
||||
"key":{"shape":"AuditCheckName"},
|
||||
"value":{"shape":"ReasonForNonComplianceCodes"}
|
||||
},
|
||||
"AuditDetails":{
|
||||
"type":"map",
|
||||
"key":{"shape":"AuditCheckName"},
|
||||
|
|
@ -3410,9 +3610,13 @@
|
|||
"AuditFinding":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"findingId":{
|
||||
"shape":"FindingId",
|
||||
"documentation":"<p>A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.</p>"
|
||||
},
|
||||
"taskId":{
|
||||
"shape":"AuditTaskId",
|
||||
"documentation":"<p>The ID of the audit that generated this result (finding)</p>"
|
||||
"documentation":"<p>The ID of the audit that generated this result (finding).</p>"
|
||||
},
|
||||
"checkName":{
|
||||
"shape":"AuditCheckName",
|
||||
|
|
@ -3432,7 +3636,7 @@
|
|||
},
|
||||
"nonCompliantResource":{
|
||||
"shape":"NonCompliantResource",
|
||||
"documentation":"<p>The resource that was found to be non-compliant with the audit check.</p>"
|
||||
"documentation":"<p>The resource that was found to be noncompliant with the audit check.</p>"
|
||||
},
|
||||
"relatedResources":{
|
||||
"shape":"RelatedResources",
|
||||
|
|
@ -3440,11 +3644,11 @@
|
|||
},
|
||||
"reasonForNonCompliance":{
|
||||
"shape":"ReasonForNonCompliance",
|
||||
"documentation":"<p>The reason the resource was non-compliant.</p>"
|
||||
"documentation":"<p>The reason the resource was noncompliant.</p>"
|
||||
},
|
||||
"reasonForNonComplianceCode":{
|
||||
"shape":"ReasonForNonComplianceCode",
|
||||
"documentation":"<p>A code which indicates the reason that the resource was non-compliant.</p>"
|
||||
"documentation":"<p>A code that indicates the reason that the resource was noncompliant.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The findings (results) of the audit.</p>"
|
||||
|
|
@ -3471,6 +3675,123 @@
|
|||
"MONTHLY"
|
||||
]
|
||||
},
|
||||
"AuditMitigationActionExecutionMetadata":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"taskId":{
|
||||
"shape":"AuditMitigationActionsTaskId",
|
||||
"documentation":"<p>The unique identifier for the task that applies the mitigation action.</p>"
|
||||
},
|
||||
"findingId":{
|
||||
"shape":"FindingId",
|
||||
"documentation":"<p>The unique identifier for the findings to which the task and associated mitigation action are applied.</p>"
|
||||
},
|
||||
"actionName":{
|
||||
"shape":"MitigationActionName",
|
||||
"documentation":"<p>The friendly name of the mitigation action being applied by the task.</p>"
|
||||
},
|
||||
"actionId":{
|
||||
"shape":"MitigationActionId",
|
||||
"documentation":"<p>The unique identifier for the mitigation action being applied by the task.</p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"AuditMitigationActionsExecutionStatus",
|
||||
"documentation":"<p>The current status of the task being executed.</p>"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the task was started.</p>"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the task was completed or canceled. Blank if the task is still running.</p>"
|
||||
},
|
||||
"errorCode":{
|
||||
"shape":"ErrorCode",
|
||||
"documentation":"<p>If an error occurred, the code that indicates which type of error occurred.</p>"
|
||||
},
|
||||
"message":{
|
||||
"shape":"ErrorMessage",
|
||||
"documentation":"<p>If an error occurred, a message that describes the error.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.</p>"
|
||||
},
|
||||
"AuditMitigationActionExecutionMetadataList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AuditMitigationActionExecutionMetadata"}
|
||||
},
|
||||
"AuditMitigationActionsExecutionStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IN_PROGRESS",
|
||||
"COMPLETED",
|
||||
"FAILED",
|
||||
"CANCELED",
|
||||
"SKIPPED",
|
||||
"PENDING"
|
||||
]
|
||||
},
|
||||
"AuditMitigationActionsTaskId":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z0-9_-]+"
|
||||
},
|
||||
"AuditMitigationActionsTaskMetadata":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"taskId":{
|
||||
"shape":"AuditMitigationActionsTaskId",
|
||||
"documentation":"<p>The unique identifier for the task.</p>"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time at which the audit mitigation actions task was started.</p>"
|
||||
},
|
||||
"taskStatus":{
|
||||
"shape":"AuditMitigationActionsTaskStatus",
|
||||
"documentation":"<p>The current state of the audit mitigation actions task.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about an audit mitigation actions task that is returned by <code>ListAuditMitigationActionsTasks</code>.</p>"
|
||||
},
|
||||
"AuditMitigationActionsTaskMetadataList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AuditMitigationActionsTaskMetadata"}
|
||||
},
|
||||
"AuditMitigationActionsTaskStatistics":{
|
||||
"type":"map",
|
||||
"key":{"shape":"AuditCheckName"},
|
||||
"value":{"shape":"TaskStatisticsForAuditCheck"}
|
||||
},
|
||||
"AuditMitigationActionsTaskStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IN_PROGRESS",
|
||||
"COMPLETED",
|
||||
"FAILED",
|
||||
"CANCELED"
|
||||
]
|
||||
},
|
||||
"AuditMitigationActionsTaskTarget":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"auditTaskId":{
|
||||
"shape":"AuditTaskId",
|
||||
"documentation":"<p>If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.</p>"
|
||||
},
|
||||
"findingIds":{
|
||||
"shape":"FindingIds",
|
||||
"documentation":"<p>If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.</p>"
|
||||
},
|
||||
"auditCheckToReasonCodeFilter":{
|
||||
"shape":"AuditCheckToReasonCodeFilter",
|
||||
"documentation":"<p>Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.</p>"
|
||||
},
|
||||
"AuditNotificationTarget":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3513,11 +3834,11 @@
|
|||
},
|
||||
"taskStatus":{
|
||||
"shape":"AuditTaskStatus",
|
||||
"documentation":"<p>The status of this audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\" or \"CANCELED\".</p>"
|
||||
"documentation":"<p>The status of this audit. One of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".</p>"
|
||||
},
|
||||
"taskType":{
|
||||
"shape":"AuditTaskType",
|
||||
"documentation":"<p>The type of this audit: one of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".</p>"
|
||||
"documentation":"<p>The type of this audit. One of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The audits that were performed.</p>"
|
||||
|
|
@ -3882,10 +4203,31 @@
|
|||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"CACertificateUpdateAction":{
|
||||
"type":"string",
|
||||
"enum":["DEACTIVATE"]
|
||||
},
|
||||
"CACertificates":{
|
||||
"type":"list",
|
||||
"member":{"shape":"CACertificate"}
|
||||
},
|
||||
"CancelAuditMitigationActionsTaskRequest":{
|
||||
"type":"structure",
|
||||
"required":["taskId"],
|
||||
"members":{
|
||||
"taskId":{
|
||||
"shape":"AuditMitigationActionsTaskId",
|
||||
"documentation":"<p>The unique identifier for the task that you want to cancel. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"taskId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CancelAuditMitigationActionsTaskResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"CancelAuditTaskRequest":{
|
||||
"type":"structure",
|
||||
"required":["taskId"],
|
||||
|
|
@ -3995,6 +4337,7 @@
|
|||
}
|
||||
},
|
||||
"CanceledChecksCount":{"type":"integer"},
|
||||
"CanceledFindingsCount":{"type":"long"},
|
||||
"CanceledThings":{"type":"integer"},
|
||||
"CannedAccessControlList":{
|
||||
"type":"string",
|
||||
|
|
@ -4196,6 +4539,12 @@
|
|||
}
|
||||
},
|
||||
"ClientId":{"type":"string"},
|
||||
"ClientRequestToken":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"^[a-zA-Z0-9-_]+$"
|
||||
},
|
||||
"CloudwatchAlarmAction":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -4646,6 +4995,47 @@
|
|||
},
|
||||
"documentation":"<p>The output of the CreateKeysAndCertificate operation.</p>"
|
||||
},
|
||||
"CreateMitigationActionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"actionName",
|
||||
"roleArn",
|
||||
"actionParams"
|
||||
],
|
||||
"members":{
|
||||
"actionName":{
|
||||
"shape":"MitigationActionName",
|
||||
"documentation":"<p>A friendly name for the action. Choose a friendly name that accurately describes the action (for example, <code>EnableLoggingAction</code>).</p>",
|
||||
"location":"uri",
|
||||
"locationName":"actionName"
|
||||
},
|
||||
"roleArn":{
|
||||
"shape":"RoleArn",
|
||||
"documentation":"<p>The ARN of the IAM role that is used to apply the mitigation action.</p>"
|
||||
},
|
||||
"actionParams":{
|
||||
"shape":"MitigationActionParams",
|
||||
"documentation":"<p>Defines the type of action and the parameters for that action.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>Metadata that can be used to manage the mitigation action.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateMitigationActionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"actionArn":{
|
||||
"shape":"MitigationActionArn",
|
||||
"documentation":"<p>The ARN for the new mitigation action.</p>"
|
||||
},
|
||||
"actionId":{
|
||||
"shape":"MitigationActionId",
|
||||
"documentation":"<p>A unique identifier for the new mitigation action.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateOTAUpdateRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -4856,7 +5246,7 @@
|
|||
"members":{
|
||||
"frequency":{
|
||||
"shape":"AuditFrequency",
|
||||
"documentation":"<p>How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.</p>"
|
||||
"documentation":"<p>How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The start time of each audit is determined by the system.</p>"
|
||||
},
|
||||
"dayOfMonth":{
|
||||
"shape":"DayOfMonth",
|
||||
|
|
@ -4864,21 +5254,21 @@
|
|||
},
|
||||
"dayOfWeek":{
|
||||
"shape":"DayOfWeek",
|
||||
"documentation":"<p>The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".</p>"
|
||||
"documentation":"<p>The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".</p>"
|
||||
},
|
||||
"targetCheckNames":{
|
||||
"shape":"TargetAuditCheckNames",
|
||||
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>Metadata which can be used to manage the scheduled audit.</p>"
|
||||
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
|
||||
},
|
||||
"scheduledAuditName":{
|
||||
"shape":"ScheduledAuditName",
|
||||
"documentation":"<p>The name you want to give to the scheduled audit. (Max. 128 chars)</p>",
|
||||
"location":"uri",
|
||||
"locationName":"scheduledAuditName"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>Metadata that can be used to manage the scheduled audit.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4915,11 +5305,11 @@
|
|||
},
|
||||
"additionalMetricsToRetain":{
|
||||
"shape":"AdditionalMetricsToRetainList",
|
||||
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code> but it is also retained for any metric specified here.</p>"
|
||||
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>Metadata which can be used to manage the security profile.</p>"
|
||||
"documentation":"<p>Metadata that can be used to manage the security profile.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -5279,7 +5669,7 @@
|
|||
},
|
||||
"forceDelete":{
|
||||
"shape":"ForceDelete",
|
||||
"documentation":"<p>Forces a certificate request to be deleted.</p>",
|
||||
"documentation":"<p>Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"forceDelete"
|
||||
}
|
||||
|
|
@ -5373,6 +5763,23 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DeleteMitigationActionRequest":{
|
||||
"type":"structure",
|
||||
"required":["actionName"],
|
||||
"members":{
|
||||
"actionName":{
|
||||
"shape":"MitigationActionName",
|
||||
"documentation":"<p>The name of the mitigation action that you want to delete.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"actionName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteMitigationActionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteOTAUpdateRequest":{
|
||||
"type":"structure",
|
||||
"required":["otaUpdateId"],
|
||||
|
|
@ -5496,7 +5903,7 @@
|
|||
},
|
||||
"expectedVersion":{
|
||||
"shape":"OptionalVersion",
|
||||
"documentation":"<p>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a <code>VersionConflictException</code> is thrown.</p>",
|
||||
"documentation":"<p>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a <code>VersionConflictException</code> is thrown.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"expectedVersion"
|
||||
}
|
||||
|
|
@ -5675,7 +6082,7 @@
|
|||
"members":{
|
||||
"roleArn":{
|
||||
"shape":"RoleArn",
|
||||
"documentation":"<p>The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.</p> <p>On the first call to <code>UpdateAccountAuditConfiguration</code> this parameter is required.</p>"
|
||||
"documentation":"<p>The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.</p> <p>On the first call to <code>UpdateAccountAuditConfiguration</code>, this parameter is required.</p>"
|
||||
},
|
||||
"auditNotificationTargetConfigurations":{
|
||||
"shape":"AuditNotificationTargetConfigurations",
|
||||
|
|
@ -5687,6 +6094,69 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DescribeAuditFindingRequest":{
|
||||
"type":"structure",
|
||||
"required":["findingId"],
|
||||
"members":{
|
||||
"findingId":{
|
||||
"shape":"FindingId",
|
||||
"documentation":"<p>A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"findingId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeAuditFindingResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"finding":{"shape":"AuditFinding"}
|
||||
}
|
||||
},
|
||||
"DescribeAuditMitigationActionsTaskRequest":{
|
||||
"type":"structure",
|
||||
"required":["taskId"],
|
||||
"members":{
|
||||
"taskId":{
|
||||
"shape":"AuditMitigationActionsTaskId",
|
||||
"documentation":"<p>The unique identifier for the audit mitigation task.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"taskId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeAuditMitigationActionsTaskResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"taskStatus":{
|
||||
"shape":"AuditMitigationActionsTaskStatus",
|
||||
"documentation":"<p>The current status of the task.</p>"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the task was started.</p>"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the task was completed or canceled.</p>"
|
||||
},
|
||||
"taskStatistics":{
|
||||
"shape":"AuditMitigationActionsTaskStatistics",
|
||||
"documentation":"<p>Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.</p>"
|
||||
},
|
||||
"target":{
|
||||
"shape":"AuditMitigationActionsTaskTarget",
|
||||
"documentation":"<p>Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.</p>"
|
||||
},
|
||||
"auditCheckToActionsMapping":{
|
||||
"shape":"AuditCheckToActionsMapping",
|
||||
"documentation":"<p>Specifies the mitigation actions that should be applied to specific audit checks.</p>"
|
||||
},
|
||||
"actionsDefinition":{
|
||||
"shape":"MitigationActionList",
|
||||
"documentation":"<p>Specifies the mitigation actions and their parameters that are applied as part of this task.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeAuditTaskRequest":{
|
||||
"type":"structure",
|
||||
"required":["taskId"],
|
||||
|
|
@ -5988,6 +6458,55 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DescribeMitigationActionRequest":{
|
||||
"type":"structure",
|
||||
"required":["actionName"],
|
||||
"members":{
|
||||
"actionName":{
|
||||
"shape":"MitigationActionName",
|
||||
"documentation":"<p>The friendly name that uniquely identifies the mitigation action.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"actionName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeMitigationActionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"actionName":{
|
||||
"shape":"MitigationActionName",
|
||||
"documentation":"<p>The friendly name that uniquely identifies the mitigation action.</p>"
|
||||
},
|
||||
"actionType":{
|
||||
"shape":"MitigationActionType",
|
||||
"documentation":"<p>The type of mitigation action.</p>"
|
||||
},
|
||||
"actionArn":{
|
||||
"shape":"MitigationActionArn",
|
||||
"documentation":"<p>The ARN that identifies this migration action.</p>"
|
||||
},
|
||||
"actionId":{
|
||||
"shape":"MitigationActionId",
|
||||
"documentation":"<p>A unique identifier for this action.</p>"
|
||||
},
|
||||
"roleArn":{
|
||||
"shape":"RoleArn",
|
||||
"documentation":"<p>The ARN of the IAM role used to apply this action.</p>"
|
||||
},
|
||||
"actionParams":{
|
||||
"shape":"MitigationActionParams",
|
||||
"documentation":"<p>Parameters that control how the mitigation action is applied, specific to the type of mitigation action.</p>"
|
||||
},
|
||||
"creationDate":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the mitigation action was added to your AWS account.</p>"
|
||||
},
|
||||
"lastModifiedDate":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the mitigation action was last changed.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeRoleAliasRequest":{
|
||||
"type":"structure",
|
||||
"required":["roleAlias"],
|
||||
|
|
@ -6026,7 +6545,7 @@
|
|||
"members":{
|
||||
"frequency":{
|
||||
"shape":"AuditFrequency",
|
||||
"documentation":"<p>How often the scheduled audit takes place. One of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.</p>"
|
||||
"documentation":"<p>How often the scheduled audit takes place. One of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\", or \"MONTHLY\". The start time of each audit is determined by the system.</p>"
|
||||
},
|
||||
"dayOfMonth":{
|
||||
"shape":"DayOfMonth",
|
||||
|
|
@ -6034,11 +6553,11 @@
|
|||
},
|
||||
"dayOfWeek":{
|
||||
"shape":"DayOfWeek",
|
||||
"documentation":"<p>The day of the week on which the scheduled audit takes place. One of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\".</p>"
|
||||
"documentation":"<p>The day of the week on which the scheduled audit takes place. One of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\".</p>"
|
||||
},
|
||||
"targetCheckNames":{
|
||||
"shape":"TargetAuditCheckNames",
|
||||
"documentation":"<p>Which checks are performed during the scheduled audit. (Note that checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
|
||||
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
|
||||
},
|
||||
"scheduledAuditName":{
|
||||
"shape":"ScheduledAuditName",
|
||||
|
|
@ -6087,7 +6606,7 @@
|
|||
},
|
||||
"additionalMetricsToRetain":{
|
||||
"shape":"AdditionalMetricsToRetainList",
|
||||
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code> but it is also retained for any metric specified here.</p>"
|
||||
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>"
|
||||
},
|
||||
"version":{
|
||||
"shape":"Version",
|
||||
|
|
@ -6459,6 +6978,15 @@
|
|||
"min":1,
|
||||
"pattern":"[^\\p{C}]*+"
|
||||
},
|
||||
"DeviceCertificateUpdateAction":{
|
||||
"type":"string",
|
||||
"enum":["DEACTIVATE"]
|
||||
},
|
||||
"DeviceDefenderThingName":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1
|
||||
},
|
||||
"DisableAllLogs":{"type":"boolean"},
|
||||
"DisableTopicRuleRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -6622,6 +7150,24 @@
|
|||
"ElasticsearchId":{"type":"string"},
|
||||
"ElasticsearchIndex":{"type":"string"},
|
||||
"ElasticsearchType":{"type":"string"},
|
||||
"EnableIoTLoggingParams":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"roleArnForLogging",
|
||||
"logLevel"
|
||||
],
|
||||
"members":{
|
||||
"roleArnForLogging":{
|
||||
"shape":"RoleArn",
|
||||
"documentation":"<p>The ARN of the IAM role used for logging.</p>"
|
||||
},
|
||||
"logLevel":{
|
||||
"shape":"LogLevel",
|
||||
"documentation":"<p>Specifies the types of information to be logged.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Parameters used when defining a mitigation action that enable AWS IoT logging.</p>"
|
||||
},
|
||||
"EnableTopicRuleRequest":{
|
||||
"type":"structure",
|
||||
"required":["ruleName"],
|
||||
|
|
@ -6724,6 +7270,7 @@
|
|||
"documentation":"<p>Allows you to create an exponential rate of rollout for a job.</p>"
|
||||
},
|
||||
"FailedChecksCount":{"type":"integer"},
|
||||
"FailedFindingsCount":{"type":"long"},
|
||||
"FailedThings":{"type":"integer"},
|
||||
"FileId":{
|
||||
"type":"integer",
|
||||
|
|
@ -6745,6 +7292,18 @@
|
|||
"documentation":"<p>The location of the OTA update.</p>"
|
||||
},
|
||||
"FileName":{"type":"string"},
|
||||
"FindingId":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z0-9_-]+"
|
||||
},
|
||||
"FindingIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FindingId"},
|
||||
"max":25,
|
||||
"min":1
|
||||
},
|
||||
"FirehoseAction":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -7265,7 +7824,7 @@
|
|||
"documentation":"<p>The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Sends messge data to an AWS IoT Analytics channel.</p>"
|
||||
"documentation":"<p>Sends message data to an AWS IoT Analytics channel.</p>"
|
||||
},
|
||||
"IotEventsAction":{
|
||||
"type":"structure",
|
||||
|
|
@ -7724,7 +8283,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
"thingName":{
|
||||
"shape":"ThingName",
|
||||
"shape":"DeviceDefenderThingName",
|
||||
"documentation":"<p>The name of the thing whose active violations are listed.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"thingName"
|
||||
|
|
@ -7768,7 +8327,7 @@
|
|||
"members":{
|
||||
"target":{
|
||||
"shape":"PolicyTarget",
|
||||
"documentation":"<p>The group for which the policies will be listed.</p>",
|
||||
"documentation":"<p>The group or principal for which the policies will be listed.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"target"
|
||||
},
|
||||
|
|
@ -7818,7 +8377,7 @@
|
|||
},
|
||||
"resourceIdentifier":{
|
||||
"shape":"ResourceIdentifier",
|
||||
"documentation":"<p>Information identifying the non-compliant resource.</p>"
|
||||
"documentation":"<p>Information identifying the noncompliant resource.</p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -7851,6 +8410,122 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListAuditMitigationActionsExecutionsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"taskId",
|
||||
"findingId"
|
||||
],
|
||||
"members":{
|
||||
"taskId":{
|
||||
"shape":"AuditMitigationActionsTaskId",
|
||||
"documentation":"<p>Specify this filter to limit results to actions for a specific audit mitigation actions task.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"taskId"
|
||||
},
|
||||
"actionStatus":{
|
||||
"shape":"AuditMitigationActionsExecutionStatus",
|
||||
"documentation":"<p>Specify this filter to limit results to those with a specific status.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"actionStatus"
|
||||
},
|
||||
"findingId":{
|
||||
"shape":"FindingId",
|
||||
"documentation":"<p>Specify this filter to limit results to those that were applied to a specific audit finding.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"findingId"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to return at one time. The default is 25.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token for the next set of results.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListAuditMitigationActionsExecutionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"actionsExecutions":{
|
||||
"shape":"AuditMitigationActionExecutionMetadataList",
|
||||
"documentation":"<p>A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token for the next set of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListAuditMitigationActionsTasksRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"startTime",
|
||||
"endTime"
|
||||
],
|
||||
"members":{
|
||||
"auditTaskId":{
|
||||
"shape":"AuditTaskId",
|
||||
"documentation":"<p>Specify this filter to limit results to tasks that were applied to results for a specific audit.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"auditTaskId"
|
||||
},
|
||||
"findingId":{
|
||||
"shape":"FindingId",
|
||||
"documentation":"<p>Specify this filter to limit results to tasks that were applied to a specific audit finding.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"findingId"
|
||||
},
|
||||
"taskStatus":{
|
||||
"shape":"AuditMitigationActionsTaskStatus",
|
||||
"documentation":"<p>Specify this filter to limit results to tasks that are in a specific state.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"taskStatus"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to return at one time. The default is 25.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token for the next set of results.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Specify this filter to limit results to tasks that began on or after a specific date and time.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"startTime"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"endTime"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListAuditMitigationActionsTasksResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"tasks":{
|
||||
"shape":"AuditMitigationActionsTaskMetadataList",
|
||||
"documentation":"<p>The collection of audit mitigation tasks that matched the filter criteria.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token for the next set of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListAuditTasksRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -7860,7 +8535,7 @@
|
|||
"members":{
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The beginning of the time period. Note that audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an \"InvalidRequestException\".</p>",
|
||||
"documentation":"<p>The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an \"InvalidRequestException\".</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"startTime"
|
||||
},
|
||||
|
|
@ -7878,7 +8553,7 @@
|
|||
},
|
||||
"taskStatus":{
|
||||
"shape":"AuditTaskStatus",
|
||||
"documentation":"<p>A filter to limit the output to audits with the specified completion status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\" or \"CANCELED\".</p>",
|
||||
"documentation":"<p>A filter to limit the output to audits with the specified completion status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"taskStatus"
|
||||
},
|
||||
|
|
@ -8278,6 +8953,42 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListMitigationActionsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"actionType":{
|
||||
"shape":"MitigationActionType",
|
||||
"documentation":"<p>Specify a value to limit the result to mitigation actions with a specific action type.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"actionType"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to return at one time. The default is 25.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token for the next set of results.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListMitigationActionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"actionIdentifiers":{
|
||||
"shape":"MitigationActionIdentifierList",
|
||||
"documentation":"<p>A set of actions that matched the specified filter criteria.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token for the next set of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListOTAUpdatesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -8626,7 +9337,7 @@
|
|||
},
|
||||
"recursive":{
|
||||
"shape":"Recursive",
|
||||
"documentation":"<p>If true, return child groups as well.</p>",
|
||||
"documentation":"<p>If true, return child groups too.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"recursive"
|
||||
},
|
||||
|
|
@ -9284,7 +9995,7 @@
|
|||
"locationName":"endTime"
|
||||
},
|
||||
"thingName":{
|
||||
"shape":"ThingName",
|
||||
"shape":"DeviceDefenderThingName",
|
||||
"documentation":"<p>A filter to limit results to those alerts caused by the specified thing.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"thingName"
|
||||
|
|
@ -9314,7 +10025,7 @@
|
|||
"members":{
|
||||
"violationEvents":{
|
||||
"shape":"ViolationEvents",
|
||||
"documentation":"<p>The security profile violation alerts issued for this account during the given time frame, potentially filtered by security profile, behavior violated, or thing (device) violating.</p>"
|
||||
"documentation":"<p>The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
|
|
@ -9460,6 +10171,108 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"MissingContextValue"}
|
||||
},
|
||||
"MitigationAction":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"name":{
|
||||
"shape":"MitigationActionName",
|
||||
"documentation":"<p>A user-friendly name for the mitigation action.</p>"
|
||||
},
|
||||
"id":{
|
||||
"shape":"MitigationActionId",
|
||||
"documentation":"<p>A unique identifier for the mitigation action.</p>"
|
||||
},
|
||||
"roleArn":{
|
||||
"shape":"RoleArn",
|
||||
"documentation":"<p>The IAM role ARN used to apply this mitigation action.</p>"
|
||||
},
|
||||
"actionParams":{
|
||||
"shape":"MitigationActionParams",
|
||||
"documentation":"<p>The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes which changes should be applied as part of a mitigation action.</p>"
|
||||
},
|
||||
"MitigationActionArn":{"type":"string"},
|
||||
"MitigationActionId":{"type":"string"},
|
||||
"MitigationActionIdentifier":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"actionName":{
|
||||
"shape":"MitigationActionName",
|
||||
"documentation":"<p>The friendly name of the mitigation action.</p>"
|
||||
},
|
||||
"actionArn":{
|
||||
"shape":"MitigationActionArn",
|
||||
"documentation":"<p>The IAM role ARN used to apply this mitigation action.</p>"
|
||||
},
|
||||
"creationDate":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date when this mitigation action was created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information that identifies a mitigation action. This information is returned by ListMitigationActions.</p>"
|
||||
},
|
||||
"MitigationActionIdentifierList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"MitigationActionIdentifier"}
|
||||
},
|
||||
"MitigationActionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"MitigationAction"}
|
||||
},
|
||||
"MitigationActionName":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"pattern":"[a-zA-Z0-9_-]+"
|
||||
},
|
||||
"MitigationActionNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"MitigationActionName"},
|
||||
"max":5,
|
||||
"min":1
|
||||
},
|
||||
"MitigationActionParams":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"updateDeviceCertificateParams":{
|
||||
"shape":"UpdateDeviceCertificateParams",
|
||||
"documentation":"<p>Parameters to define a mitigation action that changes the state of the device certificate to inactive.</p>"
|
||||
},
|
||||
"updateCACertificateParams":{
|
||||
"shape":"UpdateCACertificateParams",
|
||||
"documentation":"<p>Parameters to define a mitigation action that changes the state of the CA certificate to inactive.</p>"
|
||||
},
|
||||
"addThingsToThingGroupParams":{
|
||||
"shape":"AddThingsToThingGroupParams",
|
||||
"documentation":"<p>Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.</p>"
|
||||
},
|
||||
"replaceDefaultPolicyVersionParams":{
|
||||
"shape":"ReplaceDefaultPolicyVersionParams",
|
||||
"documentation":"<p>Parameters to define a mitigation action that adds a blank policy to restrict permissions.</p>"
|
||||
},
|
||||
"enableIoTLoggingParams":{
|
||||
"shape":"EnableIoTLoggingParams",
|
||||
"documentation":"<p>Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.</p>"
|
||||
},
|
||||
"publishFindingToSnsParams":{
|
||||
"shape":"PublishFindingToSnsParams",
|
||||
"documentation":"<p>Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).</p>"
|
||||
},
|
||||
"MitigationActionType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"UPDATE_DEVICE_CERTIFICATE",
|
||||
"UPDATE_CA_CERTIFICATE",
|
||||
"ADD_THINGS_TO_THING_GROUP",
|
||||
"REPLACE_DEFAULT_POLICY_VERSION",
|
||||
"ENABLE_IOT_LOGGING",
|
||||
"PUBLISH_FINDING_TO_SNS"
|
||||
]
|
||||
},
|
||||
"NextToken":{"type":"string"},
|
||||
"NonCompliantChecksCount":{"type":"integer"},
|
||||
"NonCompliantResource":{
|
||||
|
|
@ -9467,18 +10280,18 @@
|
|||
"members":{
|
||||
"resourceType":{
|
||||
"shape":"ResourceType",
|
||||
"documentation":"<p>The type of the non-compliant resource.</p>"
|
||||
"documentation":"<p>The type of the noncompliant resource.</p>"
|
||||
},
|
||||
"resourceIdentifier":{
|
||||
"shape":"ResourceIdentifier",
|
||||
"documentation":"<p>Information identifying the non-compliant resource.</p>"
|
||||
"documentation":"<p>Information that identifies the noncompliant resource.</p>"
|
||||
},
|
||||
"additionalInfo":{
|
||||
"shape":"StringMap",
|
||||
"documentation":"<p>Additional information about the non-compliant resource.</p>"
|
||||
"documentation":"<p>Other information about the noncompliant resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the resource that was non-compliant with the audit check.</p>"
|
||||
"documentation":"<p>Information about the resource that was noncompliant with the audit check.</p>"
|
||||
},
|
||||
"NonCompliantResourcesCount":{"type":"long"},
|
||||
"NotConfiguredException":{
|
||||
|
|
@ -9730,6 +10543,10 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"PolicyTarget"}
|
||||
},
|
||||
"PolicyTemplateName":{
|
||||
"type":"string",
|
||||
"enum":["BLANK_POLICY"]
|
||||
},
|
||||
"PolicyVersion":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -9825,17 +10642,33 @@
|
|||
"key":{"shape":"KeyName"},
|
||||
"value":{"shape":"KeyValue"}
|
||||
},
|
||||
"PublishFindingToSnsParams":{
|
||||
"type":"structure",
|
||||
"required":["topicArn"],
|
||||
"members":{
|
||||
"topicArn":{
|
||||
"shape":"SnsTopicArn",
|
||||
"documentation":"<p>The ARN of the topic to which you want to publish the findings.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.</p>"
|
||||
},
|
||||
"PutItemInput":{
|
||||
"type":"structure",
|
||||
"required":["tableName"],
|
||||
"members":{
|
||||
"tableName":{
|
||||
"shape":"TableName",
|
||||
"documentation":"<p>The table where the message data will be written</p>"
|
||||
"documentation":"<p>The table where the message data will be written.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.</p>"
|
||||
},
|
||||
"Qos":{
|
||||
"type":"integer",
|
||||
"max":1,
|
||||
"min":0
|
||||
},
|
||||
"QueryMaxResults":{
|
||||
"type":"integer",
|
||||
"max":500,
|
||||
|
|
@ -9871,6 +10704,12 @@
|
|||
},
|
||||
"ReasonForNonCompliance":{"type":"string"},
|
||||
"ReasonForNonComplianceCode":{"type":"string"},
|
||||
"ReasonForNonComplianceCodes":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ReasonForNonComplianceCode"},
|
||||
"max":25,
|
||||
"min":1
|
||||
},
|
||||
"Recursive":{"type":"boolean"},
|
||||
"RecursiveWithoutDefault":{"type":"boolean"},
|
||||
"RegisterCACertificateRequest":{
|
||||
|
|
@ -10064,11 +10903,11 @@
|
|||
},
|
||||
"resourceIdentifier":{
|
||||
"shape":"ResourceIdentifier",
|
||||
"documentation":"<p>Information identifying the resource.</p>"
|
||||
"documentation":"<p>Information that identifies the resource.</p>"
|
||||
},
|
||||
"additionalInfo":{
|
||||
"shape":"StringMap",
|
||||
"documentation":"<p>Additional information about the resource.</p>"
|
||||
"documentation":"<p>Other information about the resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a related resource.</p>"
|
||||
|
|
@ -10132,6 +10971,17 @@
|
|||
},
|
||||
"RemoveThingType":{"type":"boolean"},
|
||||
"RemovedThings":{"type":"integer"},
|
||||
"ReplaceDefaultPolicyVersionParams":{
|
||||
"type":"structure",
|
||||
"required":["templateName"],
|
||||
"members":{
|
||||
"templateName":{
|
||||
"shape":"PolicyTemplateName",
|
||||
"documentation":"<p>The name of the template to be applied. The only supported value is <code>BLANK_POLICY</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Parameters to define a mitigation action that adds a blank policy to restrict permissions.</p>"
|
||||
},
|
||||
"ReplaceTopicRuleRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -10174,6 +11024,10 @@
|
|||
"topic":{
|
||||
"shape":"TopicPattern",
|
||||
"documentation":"<p>The name of the MQTT topic.</p>"
|
||||
},
|
||||
"qos":{
|
||||
"shape":"Qos",
|
||||
"documentation":"<p>The Quality of Service (QoS) level to use when republishing messages.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an action to republish to another topic.</p>"
|
||||
|
|
@ -10218,7 +11072,7 @@
|
|||
},
|
||||
"cognitoIdentityPoolId":{
|
||||
"shape":"CognitoIdentityPoolId",
|
||||
"documentation":"<p>The ID of the Cognito Identity Pool.</p>"
|
||||
"documentation":"<p>The ID of the Amazon Cognito identity pool.</p>"
|
||||
},
|
||||
"clientId":{
|
||||
"shape":"ClientId",
|
||||
|
|
@ -10233,7 +11087,7 @@
|
|||
"documentation":"<p>The account with which the resource is associated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information identifying the non-compliant resource.</p>"
|
||||
"documentation":"<p>Information that identifies the noncompliant resource.</p>"
|
||||
},
|
||||
"ResourceLogicalId":{"type":"string"},
|
||||
"ResourceNotFoundException":{
|
||||
|
|
@ -10455,7 +11309,7 @@
|
|||
},
|
||||
"frequency":{
|
||||
"shape":"AuditFrequency",
|
||||
"documentation":"<p>How often the scheduled audit takes place.</p>"
|
||||
"documentation":"<p>How often the scheduled audit occurs.</p>"
|
||||
},
|
||||
"dayOfMonth":{
|
||||
"shape":"DayOfMonth",
|
||||
|
|
@ -10723,6 +11577,7 @@
|
|||
},
|
||||
"documentation":"<p>Describes the code-signing profile.</p>"
|
||||
},
|
||||
"SkippedFindingsCount":{"type":"long"},
|
||||
"SkyfallMaxResults":{
|
||||
"type":"integer",
|
||||
"max":250,
|
||||
|
|
@ -10750,6 +11605,10 @@
|
|||
},
|
||||
"documentation":"<p>Describes an action to publish to an Amazon SNS topic.</p>"
|
||||
},
|
||||
"SnsTopicArn":{
|
||||
"type":"string",
|
||||
"max":350
|
||||
},
|
||||
"SqlParseException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -10784,13 +11643,52 @@
|
|||
},
|
||||
"documentation":"<p>Describes an action to publish data to an Amazon SQS queue.</p>"
|
||||
},
|
||||
"StartAuditMitigationActionsTaskRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"taskId",
|
||||
"target",
|
||||
"auditCheckToActionsMapping",
|
||||
"clientRequestToken"
|
||||
],
|
||||
"members":{
|
||||
"taskId":{
|
||||
"shape":"AuditMitigationActionsTaskId",
|
||||
"documentation":"<p>A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"taskId"
|
||||
},
|
||||
"target":{
|
||||
"shape":"AuditMitigationActionsTaskTarget",
|
||||
"documentation":"<p>Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.</p>"
|
||||
},
|
||||
"auditCheckToActionsMapping":{
|
||||
"shape":"AuditCheckToActionsMapping",
|
||||
"documentation":"<p>For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.</p>"
|
||||
},
|
||||
"clientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.</p>",
|
||||
"idempotencyToken":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartAuditMitigationActionsTaskResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"taskId":{
|
||||
"shape":"AuditMitigationActionsTaskId",
|
||||
"documentation":"<p>The unique identifier for the audit mitigation task. This matches the <code>taskId</code> that you specified in the request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartOnDemandAuditTaskRequest":{
|
||||
"type":"structure",
|
||||
"required":["targetCheckNames"],
|
||||
"members":{
|
||||
"targetCheckNames":{
|
||||
"shape":"TargetAuditCheckNames",
|
||||
"documentation":"<p>Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.</p>"
|
||||
"documentation":"<p>Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -11051,6 +11949,7 @@
|
|||
"key":{"shape":"String"},
|
||||
"value":{"shape":"String"}
|
||||
},
|
||||
"SucceededFindingsCount":{"type":"long"},
|
||||
"SucceededThings":{"type":"integer"},
|
||||
"TableName":{"type":"string"},
|
||||
"Tag":{
|
||||
|
|
@ -11117,6 +12016,15 @@
|
|||
"member":{"shape":"Target"},
|
||||
"min":1
|
||||
},
|
||||
"TaskAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"errorMessage"}
|
||||
},
|
||||
"documentation":"<p>This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TaskId":{
|
||||
"type":"string",
|
||||
"max":40
|
||||
|
|
@ -11146,11 +12054,11 @@
|
|||
},
|
||||
"nonCompliantChecks":{
|
||||
"shape":"NonCompliantChecksCount",
|
||||
"documentation":"<p>The number of checks that found non-compliant resources.</p>"
|
||||
"documentation":"<p>The number of checks that found noncompliant resources.</p>"
|
||||
},
|
||||
"failedChecks":{
|
||||
"shape":"FailedChecksCount",
|
||||
"documentation":"<p>The number of checks </p>"
|
||||
"documentation":"<p>The number of checks.</p>"
|
||||
},
|
||||
"canceledChecks":{
|
||||
"shape":"CanceledChecksCount",
|
||||
|
|
@ -11159,6 +12067,32 @@
|
|||
},
|
||||
"documentation":"<p>Statistics for the checks performed during the audit.</p>"
|
||||
},
|
||||
"TaskStatisticsForAuditCheck":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"totalFindingsCount":{
|
||||
"shape":"TotalFindingsCount",
|
||||
"documentation":"<p>The total number of findings to which a task is being applied.</p>"
|
||||
},
|
||||
"failedFindingsCount":{
|
||||
"shape":"FailedFindingsCount",
|
||||
"documentation":"<p>The number of findings for which at least one of the actions failed when applied.</p>"
|
||||
},
|
||||
"succeededFindingsCount":{
|
||||
"shape":"SucceededFindingsCount",
|
||||
"documentation":"<p>The number of findings for which all mitigation actions succeeded when applied.</p>"
|
||||
},
|
||||
"skippedFindingsCount":{
|
||||
"shape":"SkippedFindingsCount",
|
||||
"documentation":"<p>The number of findings skipped because of filter conditions provided in the parameters to the command.</p>"
|
||||
},
|
||||
"canceledFindingsCount":{
|
||||
"shape":"CanceledFindingsCount",
|
||||
"documentation":"<p>The number of findings to which the mitigation action task was canceled when applied.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.</p>"
|
||||
},
|
||||
"TemplateBody":{"type":"string"},
|
||||
"TestAuthorizationRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -11436,6 +12370,12 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"ThingGroupName"}
|
||||
},
|
||||
"ThingGroupNames":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ThingGroupName"},
|
||||
"max":10,
|
||||
"min":1
|
||||
},
|
||||
"ThingGroupProperties":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -11701,6 +12641,7 @@
|
|||
"documentation":"<p>Describes a rule.</p>"
|
||||
},
|
||||
"TotalChecksCount":{"type":"integer"},
|
||||
"TotalFindingsCount":{"type":"long"},
|
||||
"TotalResourcesCount":{"type":"long"},
|
||||
"TransferAlreadyCompletedException":{
|
||||
"type":"structure",
|
||||
|
|
@ -11832,7 +12773,7 @@
|
|||
"members":{
|
||||
"roleArn":{
|
||||
"shape":"RoleArn",
|
||||
"documentation":"<p>The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.</p>"
|
||||
"documentation":"<p>The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.</p>"
|
||||
},
|
||||
"auditNotificationTargetConfigurations":{
|
||||
"shape":"AuditNotificationTargetConfigurations",
|
||||
|
|
@ -11840,7 +12781,7 @@
|
|||
},
|
||||
"auditCheckConfigurations":{
|
||||
"shape":"AuditCheckConfigurations",
|
||||
"documentation":"<p>Specifies which audit checks are enabled and disabled for this account. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are currently enabled.</p> <p>Note that some data collection may begin immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.</p> <p>You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.</p> <p>On the first call to <code>UpdateAccountAuditConfiguration</code> this parameter is required and must specify at least one enabled check.</p>"
|
||||
"documentation":"<p>Specifies which audit checks are enabled and disabled for this account. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are currently enabled.</p> <p>Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.</p> <p>You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.</p> <p>On the first call to <code>UpdateAccountAuditConfiguration</code>, this parameter is required and must specify at least one enabled check.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -11922,6 +12863,17 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"UpdateCACertificateParams":{
|
||||
"type":"structure",
|
||||
"required":["action"],
|
||||
"members":{
|
||||
"action":{
|
||||
"shape":"CACertificateUpdateAction",
|
||||
"documentation":"<p>The action that you want to apply to the CA cerrtificate. The only supported value is <code>DEACTIVATE</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Parameters to define a mitigation action that changes the state of the CA certificate to inactive.</p>"
|
||||
},
|
||||
"UpdateCACertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":["certificateId"],
|
||||
|
|
@ -11950,7 +12902,7 @@
|
|||
},
|
||||
"removeAutoRegistration":{
|
||||
"shape":"RemoveAutoRegistration",
|
||||
"documentation":"<p>If true, remove auto registration.</p>"
|
||||
"documentation":"<p>If true, removes auto registration.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input to the UpdateCACertificate operation.</p>"
|
||||
|
|
@ -11977,6 +12929,17 @@
|
|||
},
|
||||
"documentation":"<p>The input for the UpdateCertificate operation.</p>"
|
||||
},
|
||||
"UpdateDeviceCertificateParams":{
|
||||
"type":"structure",
|
||||
"required":["action"],
|
||||
"members":{
|
||||
"action":{
|
||||
"shape":"DeviceCertificateUpdateAction",
|
||||
"documentation":"<p>The action that you want to apply to the device cerrtificate. The only supported value is <code>DEACTIVATE</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Parameters to define a mitigation action that changes the state of the device certificate to inactive.</p>"
|
||||
},
|
||||
"UpdateDynamicThingGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -12085,6 +13048,39 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"UpdateMitigationActionRequest":{
|
||||
"type":"structure",
|
||||
"required":["actionName"],
|
||||
"members":{
|
||||
"actionName":{
|
||||
"shape":"MitigationActionName",
|
||||
"documentation":"<p>The friendly name for the mitigation action. You can't change the name by using <code>UpdateMitigationAction</code>. Instead, you must delete and re-create the mitigation action with the new name.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"actionName"
|
||||
},
|
||||
"roleArn":{
|
||||
"shape":"RoleArn",
|
||||
"documentation":"<p>The ARN of the IAM role that is used to apply the mitigation action.</p>"
|
||||
},
|
||||
"actionParams":{
|
||||
"shape":"MitigationActionParams",
|
||||
"documentation":"<p>Defines the type of action and the parameters for that action.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateMitigationActionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"actionArn":{
|
||||
"shape":"MitigationActionArn",
|
||||
"documentation":"<p>The ARN for the new mitigation action.</p>"
|
||||
},
|
||||
"actionId":{
|
||||
"shape":"MitigationActionId",
|
||||
"documentation":"<p>A unique identifier for the mitigation action.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateRoleAliasRequest":{
|
||||
"type":"structure",
|
||||
"required":["roleAlias"],
|
||||
|
|
@ -12124,7 +13120,7 @@
|
|||
"members":{
|
||||
"frequency":{
|
||||
"shape":"AuditFrequency",
|
||||
"documentation":"<p>How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.</p>"
|
||||
"documentation":"<p>How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\", or \"MONTHLY\". The start time of each audit is determined by the system.</p>"
|
||||
},
|
||||
"dayOfMonth":{
|
||||
"shape":"DayOfMonth",
|
||||
|
|
@ -12132,11 +13128,11 @@
|
|||
},
|
||||
"dayOfWeek":{
|
||||
"shape":"DayOfWeek",
|
||||
"documentation":"<p>The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".</p>"
|
||||
"documentation":"<p>The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".</p>"
|
||||
},
|
||||
"targetCheckNames":{
|
||||
"shape":"TargetAuditCheckNames",
|
||||
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
|
||||
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
|
||||
},
|
||||
"scheduledAuditName":{
|
||||
"shape":"ScheduledAuditName",
|
||||
|
|
@ -12179,23 +13175,23 @@
|
|||
},
|
||||
"additionalMetricsToRetain":{
|
||||
"shape":"AdditionalMetricsToRetainList",
|
||||
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code> but it is also retained for any metric specified here.</p>"
|
||||
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>"
|
||||
},
|
||||
"deleteBehaviors":{
|
||||
"shape":"DeleteBehaviors",
|
||||
"documentation":"<p>If true, delete all <code>behaviors</code> defined for this security profile. If any <code>behaviors</code> are defined in the current invocation an exception occurs.</p>"
|
||||
"documentation":"<p>If true, delete all <code>behaviors</code> defined for this security profile. If any <code>behaviors</code> are defined in the current invocation, an exception occurs.</p>"
|
||||
},
|
||||
"deleteAlertTargets":{
|
||||
"shape":"DeleteAlertTargets",
|
||||
"documentation":"<p>If true, delete all <code>alertTargets</code> defined for this security profile. If any <code>alertTargets</code> are defined in the current invocation an exception occurs.</p>"
|
||||
"documentation":"<p>If true, delete all <code>alertTargets</code> defined for this security profile. If any <code>alertTargets</code> are defined in the current invocation, an exception occurs.</p>"
|
||||
},
|
||||
"deleteAdditionalMetricsToRetain":{
|
||||
"shape":"DeleteAdditionalMetricsToRetain",
|
||||
"documentation":"<p>If true, delete all <code>additionalMetricsToRetain</code> defined for this security profile. If any <code>additionalMetricsToRetain</code> are defined in the current invocation an exception occurs.</p>"
|
||||
"documentation":"<p>If true, delete all <code>additionalMetricsToRetain</code> defined for this security profile. If any <code>additionalMetricsToRetain</code> are defined in the current invocation, an exception occurs.</p>"
|
||||
},
|
||||
"expectedVersion":{
|
||||
"shape":"OptionalVersion",
|
||||
"documentation":"<p>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a <code>VersionConflictException</code> is thrown.</p>",
|
||||
"documentation":"<p>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a <code>VersionConflictException</code> is thrown.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"expectedVersion"
|
||||
}
|
||||
|
|
@ -12226,7 +13222,7 @@
|
|||
},
|
||||
"additionalMetricsToRetain":{
|
||||
"shape":"AdditionalMetricsToRetainList",
|
||||
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's <code>behaviors</code> but it is also retained for any metric specified here.</p>"
|
||||
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>"
|
||||
},
|
||||
"version":{
|
||||
"shape":"Version",
|
||||
|
|
@ -12454,7 +13450,7 @@
|
|||
"documentation":"<p>The ID of the violation event.</p>"
|
||||
},
|
||||
"thingName":{
|
||||
"shape":"ThingName",
|
||||
"shape":"DeviceDefenderThingName",
|
||||
"documentation":"<p>The name of the thing responsible for the violation event.</p>"
|
||||
},
|
||||
"securityProfileName":{
|
||||
|
|
|
|||
3
botocore/data/lakeformation/2017-03-31/paginators-1.json
Normal file
3
botocore/data/lakeformation/2017-03-31/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
1020
botocore/data/lakeformation/2017-03-31/service-2.json
Normal file
1020
botocore/data/lakeformation/2017-03-31/service-2.json
Normal file
|
|
@ -0,0 +1,1020 @@
|
|||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2017-03-31",
|
||||
"endpointPrefix":"lakeformation",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"AWS Lake Formation",
|
||||
"serviceId":"LakeFormation",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"lakeformation",
|
||||
"targetPrefix":"AWSLakeFormation",
|
||||
"uid":"lakeformation-2017-03-31"
|
||||
},
|
||||
"operations":{
|
||||
"BatchGrantPermissions":{
|
||||
"name":"BatchGrantPermissions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchGrantPermissionsRequest"},
|
||||
"output":{"shape":"BatchGrantPermissionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"}
|
||||
],
|
||||
"documentation":"<p>Batch operation to grant permissions to the principal.</p>"
|
||||
},
|
||||
"BatchRevokePermissions":{
|
||||
"name":"BatchRevokePermissions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchRevokePermissionsRequest"},
|
||||
"output":{"shape":"BatchRevokePermissionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"}
|
||||
],
|
||||
"documentation":"<p>Batch operation to revoke permissions from the principal.</p>"
|
||||
},
|
||||
"DeregisterResource":{
|
||||
"name":"DeregisterResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeregisterResourceRequest"},
|
||||
"output":{"shape":"DeregisterResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"EntityNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Deregisters the resource as managed by the Data Catalog.</p> <p>When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.</p>"
|
||||
},
|
||||
"DescribeResource":{
|
||||
"name":"DescribeResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeResourceRequest"},
|
||||
"output":{"shape":"DescribeResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"EntityNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the current data access role for the given resource registered in AWS Lake Formation.</p>"
|
||||
},
|
||||
"GetDataLakeSettings":{
|
||||
"name":"GetDataLakeSettings",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetDataLakeSettingsRequest"},
|
||||
"output":{"shape":"GetDataLakeSettingsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"EntityNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>The AWS Lake Formation principal.</p>"
|
||||
},
|
||||
"GetEffectivePermissionsForPath":{
|
||||
"name":"GetEffectivePermissionsForPath",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetEffectivePermissionsForPathRequest"},
|
||||
"output":{"shape":"GetEffectivePermissionsForPathResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Returns the permissions for a specified table or database resource located at a path in Amazon S3.</p>"
|
||||
},
|
||||
"GrantPermissions":{
|
||||
"name":"GrantPermissions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GrantPermissionsRequest"},
|
||||
"output":{"shape":"GrantPermissionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
],
|
||||
"documentation":"<p>Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.</p> <p>For information about permissions, see <a href=\"https://docs-aws.amazon.com/michigan/latest/dg/security-data-access.html\">Security and Access Control to Metadata and Data</a>.</p>"
|
||||
},
|
||||
"ListPermissions":{
|
||||
"name":"ListPermissions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListPermissionsRequest"},
|
||||
"output":{"shape":"ListPermissionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.</p> <p>This operation returns only those permissions that have been explicitly granted.</p> <p>For information about permissions, see <a href=\"https://docs-aws.amazon.com/michigan/latest/dg/security-data-access.html\">Security and Access Control to Metadata and Data</a>.</p>"
|
||||
},
|
||||
"ListResources":{
|
||||
"name":"ListResources",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListResourcesRequest"},
|
||||
"output":{"shape":"ListResourcesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"}
|
||||
],
|
||||
"documentation":"<p>Lists the resources registered to be managed by the Data Catalog.</p>"
|
||||
},
|
||||
"PutDataLakeSettings":{
|
||||
"name":"PutDataLakeSettings",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"PutDataLakeSettingsRequest"},
|
||||
"output":{"shape":"PutDataLakeSettingsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
],
|
||||
"documentation":"<p>The AWS Lake Formation principal.</p>"
|
||||
},
|
||||
"RegisterResource":{
|
||||
"name":"RegisterResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RegisterResourceRequest"},
|
||||
"output":{"shape":"RegisterResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"AlreadyExistsException"}
|
||||
],
|
||||
"documentation":"<p>Registers the resource as managed by the Data Catalog.</p> <p>To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.</p>"
|
||||
},
|
||||
"RevokePermissions":{
|
||||
"name":"RevokePermissions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RevokePermissionsRequest"},
|
||||
"output":{"shape":"RevokePermissionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
],
|
||||
"documentation":"<p>Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.</p>"
|
||||
},
|
||||
"UpdateResource":{
|
||||
"name":"UpdateResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateResourceRequest"},
|
||||
"output":{"shape":"UpdateResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"EntityNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation. </p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{
|
||||
"shape":"MessageString",
|
||||
"documentation":"<p>A message describing the problem.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A resource to be created or added already exists.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"BatchGrantPermissionsRequest":{
|
||||
"type":"structure",
|
||||
"required":["Entries"],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. </p>"
|
||||
},
|
||||
"Entries":{
|
||||
"shape":"BatchPermissionsRequestEntryList",
|
||||
"documentation":"<p>A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BatchGrantPermissionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Failures":{
|
||||
"shape":"BatchPermissionsFailureList",
|
||||
"documentation":"<p>A list of failures to grant permissions to the resources.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BatchPermissionsFailureEntry":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"RequestEntry":{
|
||||
"shape":"BatchPermissionsRequestEntry",
|
||||
"documentation":"<p>An identifier for an entry of the batch request.</p>"
|
||||
},
|
||||
"Error":{
|
||||
"shape":"ErrorDetail",
|
||||
"documentation":"<p>An error message that applies to the failure of the entry.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A list of failures when performing a batch grant or batch revoke operation.</p>"
|
||||
},
|
||||
"BatchPermissionsFailureList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BatchPermissionsFailureEntry"}
|
||||
},
|
||||
"BatchPermissionsRequestEntry":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"Identifier",
|
||||
"documentation":"<p>A unique identifier for the batch permissions request entry.</p>"
|
||||
},
|
||||
"Principal":{
|
||||
"shape":"DataLakePrincipal",
|
||||
"documentation":"<p>The principal to be granted a permission.</p>"
|
||||
},
|
||||
"Resource":{
|
||||
"shape":"Resource",
|
||||
"documentation":"<p>The resource to which the principal is to be granted a permission.</p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>The permissions to be granted.</p>"
|
||||
},
|
||||
"PermissionsWithGrantOption":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>Indicates if the option to pass permissions is granted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A permission to a resource granted by batch operation to the principal.</p>"
|
||||
},
|
||||
"BatchPermissionsRequestEntryList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BatchPermissionsRequestEntry"}
|
||||
},
|
||||
"BatchRevokePermissionsRequest":{
|
||||
"type":"structure",
|
||||
"required":["Entries"],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. </p>"
|
||||
},
|
||||
"Entries":{
|
||||
"shape":"BatchPermissionsRequestEntryList",
|
||||
"documentation":"<p>A list of up to 20 entries for resource permissions to be revoked by batch operation to the principal.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BatchRevokePermissionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Failures":{
|
||||
"shape":"BatchPermissionsFailureList",
|
||||
"documentation":"<p>A list of failures to revoke permissions to the resources.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CatalogIdString":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
},
|
||||
"CatalogResource":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>A structure for the catalog object.</p>"
|
||||
},
|
||||
"ColumnNames":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NameString"}
|
||||
},
|
||||
"ColumnWildcard":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ExcludedColumnNames":{
|
||||
"shape":"ColumnNames",
|
||||
"documentation":"<p>Excludes column names. Any column with this name will be excluded.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A wildcard object, consisting of an optional list of excluded column names or indexes.</p>"
|
||||
},
|
||||
"ComparisonOperator":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"EQ",
|
||||
"NE",
|
||||
"LE",
|
||||
"LT",
|
||||
"GE",
|
||||
"GT",
|
||||
"CONTAINS",
|
||||
"NOT_CONTAINS",
|
||||
"BEGINS_WITH",
|
||||
"IN",
|
||||
"BETWEEN"
|
||||
]
|
||||
},
|
||||
"ConcurrentModificationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{
|
||||
"shape":"MessageString",
|
||||
"documentation":"<p>A message describing the problem.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Two processes are trying to modify a resource simultaneously.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"DataLakePrincipal":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DataLakePrincipalIdentifier":{
|
||||
"shape":"DataLakePrincipalString",
|
||||
"documentation":"<p>An identifier for the AWS Lake Formation principal.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The AWS Lake Formation principal.</p>"
|
||||
},
|
||||
"DataLakePrincipalList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DataLakePrincipal"},
|
||||
"max":10,
|
||||
"min":0
|
||||
},
|
||||
"DataLakePrincipalString":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1
|
||||
},
|
||||
"DataLakeResourceType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CATALOG",
|
||||
"DATABASE",
|
||||
"TABLE",
|
||||
"DATA_LOCATION"
|
||||
]
|
||||
},
|
||||
"DataLakeSettings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DataLakeAdmins":{
|
||||
"shape":"DataLakePrincipalList",
|
||||
"documentation":"<p>A list of AWS Lake Formation principals.</p>"
|
||||
},
|
||||
"CreateDatabaseDefaultPermissions":{
|
||||
"shape":"PrincipalPermissionsList",
|
||||
"documentation":"<p>A list of up to three principal permissions entries for default create database permissions.</p>"
|
||||
},
|
||||
"CreateTableDefaultPermissions":{
|
||||
"shape":"PrincipalPermissionsList",
|
||||
"documentation":"<p>A list of up to three principal permissions entries for default create table permissions.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The AWS Lake Formation principal.</p>"
|
||||
},
|
||||
"DataLocationResource":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArnString",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that uniquely identifies the data location resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure for a data location object where permissions are granted or revoked. </p>"
|
||||
},
|
||||
"DatabaseResource":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the database resource. Unique to the Data Catalog.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure for the database object.</p>"
|
||||
},
|
||||
"DeregisterResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArnString",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to deregister.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeregisterResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescribeResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArnString",
|
||||
"documentation":"<p>The resource ARN.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceInfo":{
|
||||
"shape":"ResourceInfo",
|
||||
"documentation":"<p>A structure containing information about an AWS Lake Formation resource.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescriptionString":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
"min":0,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
},
|
||||
"EntityNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{
|
||||
"shape":"MessageString",
|
||||
"documentation":"<p>A message describing the problem.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A specified entity does not exist</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ErrorDetail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ErrorCode":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The code associated with this error.</p>"
|
||||
},
|
||||
"ErrorMessage":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>A message describing the error.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains details about an error.</p>"
|
||||
},
|
||||
"FieldNameString":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"RESOURCE_ARN",
|
||||
"ROLE_ARN",
|
||||
"LAST_MODIFIED"
|
||||
]
|
||||
},
|
||||
"FilterCondition":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Field":{
|
||||
"shape":"FieldNameString",
|
||||
"documentation":"<p>The field to filter in the filter condition.</p>"
|
||||
},
|
||||
"ComparisonOperator":{
|
||||
"shape":"ComparisonOperator",
|
||||
"documentation":"<p>The comparison operator used in the filter condition.</p>"
|
||||
},
|
||||
"StringValueList":{
|
||||
"shape":"StringValueList",
|
||||
"documentation":"<p>A string with values used in evaluating the filter condition.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This structure describes the filtering of columns in a table based on a filter condition.</p>"
|
||||
},
|
||||
"FilterConditionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FilterCondition"},
|
||||
"max":20,
|
||||
"min":1
|
||||
},
|
||||
"GetDataLakeSettingsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetDataLakeSettingsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DataLakeSettings":{
|
||||
"shape":"DataLakeSettings",
|
||||
"documentation":"<p>A list of AWS Lake Formation principals. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetEffectivePermissionsForPathRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. </p>"
|
||||
},
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArnString",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource for which you want to get permissions.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, if this is not the first call to retrieve this list.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum number of results to return.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetEffectivePermissionsForPathResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Permissions":{
|
||||
"shape":"PrincipalResourcePermissionsList",
|
||||
"documentation":"<p>A list of the permissions for the specified table or database resource located at the path in Amazon S3.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, if this is not the first call to retrieve this list.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GrantPermissionsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Principal",
|
||||
"Resource",
|
||||
"Permissions"
|
||||
],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. </p>"
|
||||
},
|
||||
"Principal":{
|
||||
"shape":"DataLakePrincipal",
|
||||
"documentation":"<p>The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.</p> <p>Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted. </p>"
|
||||
},
|
||||
"Resource":{
|
||||
"shape":"Resource",
|
||||
"documentation":"<p>The resource to which permissions are to be granted. Resources in AWS Lake Formation are the Data Catalog, databases, and tables.</p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>The permissions granted to the principal on the resource. AWS Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. AWS Lake Formation requires that each principal be authorized to perform a specific task on AWS Lake Formation resources. </p>"
|
||||
},
|
||||
"PermissionsWithGrantOption":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the <code>Privileges</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GrantPermissionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"IAMRoleArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws:iam::[0-9]*:role/.*"
|
||||
},
|
||||
"Identifier":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1
|
||||
},
|
||||
"InternalServiceException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{
|
||||
"shape":"MessageString",
|
||||
"documentation":"<p>A message describing the problem.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An internal service error occurred.</p>",
|
||||
"exception":true,
|
||||
"fault":true
|
||||
},
|
||||
"InvalidInputException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{
|
||||
"shape":"MessageString",
|
||||
"documentation":"<p>A message describing the problem.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input provided was not valid.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"LastModifiedTimestamp":{"type":"timestamp"},
|
||||
"ListPermissionsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. </p>"
|
||||
},
|
||||
"Principal":{
|
||||
"shape":"DataLakePrincipal",
|
||||
"documentation":"<p>Specifies a principal to filter the permissions returned.</p>"
|
||||
},
|
||||
"ResourceType":{
|
||||
"shape":"DataLakeResourceType",
|
||||
"documentation":"<p>Specifies a resource type to filter the permissions returned.</p>"
|
||||
},
|
||||
"Resource":{
|
||||
"shape":"Resource",
|
||||
"documentation":"<p>A resource where you will get a list of the principal permissions.</p> <p>This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, if this is not the first call to retrieve this list.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum number of results to return.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListPermissionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PrincipalResourcePermissions":{
|
||||
"shape":"PrincipalResourcePermissionsList",
|
||||
"documentation":"<p>A list of principals and their permissions on the resource for the specified principal and resource types.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, if this is not the first call to retrieve this list.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListResourcesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"FilterConditionList":{
|
||||
"shape":"FilterConditionList",
|
||||
"documentation":"<p>Any applicable row-level and/or column-level filtering conditions for the resources.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum number of resource results.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, if this is not the first call to retrieve these resources.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListResourcesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceInfoList":{
|
||||
"shape":"ResourceInfoList",
|
||||
"documentation":"<p>A summary of the data lake resources.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, if this is not the first call to retrieve these resources.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MessageString":{"type":"string"},
|
||||
"NameString":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
},
|
||||
"NullableBoolean":{
|
||||
"type":"boolean",
|
||||
"box":true
|
||||
},
|
||||
"OperationTimeoutException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{
|
||||
"shape":"MessageString",
|
||||
"documentation":"<p>A message describing the problem.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The operation timed out.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"PageSize":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
"max":1000,
|
||||
"min":1
|
||||
},
|
||||
"Permission":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ALL",
|
||||
"SELECT",
|
||||
"ALTER",
|
||||
"DROP",
|
||||
"DELETE",
|
||||
"INSERT",
|
||||
"CREATE_DATABASE",
|
||||
"CREATE_TABLE",
|
||||
"DATA_LOCATION_ACCESS"
|
||||
]
|
||||
},
|
||||
"PermissionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Permission"}
|
||||
},
|
||||
"PrincipalPermissions":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Principal":{
|
||||
"shape":"DataLakePrincipal",
|
||||
"documentation":"<p>The principal who is granted permissions.</p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>The permissions that are granted to the principal.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Permissions granted to a principal.</p>"
|
||||
},
|
||||
"PrincipalPermissionsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PrincipalPermissions"}
|
||||
},
|
||||
"PrincipalResourcePermissions":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Principal":{
|
||||
"shape":"DataLakePrincipal",
|
||||
"documentation":"<p>The Data Lake principal to be granted or revoked permissions.</p>"
|
||||
},
|
||||
"Resource":{
|
||||
"shape":"Resource",
|
||||
"documentation":"<p>The resource where permissions are to be granted or revoked.</p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>The permissions to be granted or revoked on the resource.</p>"
|
||||
},
|
||||
"PermissionsWithGrantOption":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The permissions granted or revoked on a resource.</p>"
|
||||
},
|
||||
"PrincipalResourcePermissionsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PrincipalResourcePermissions"}
|
||||
},
|
||||
"PutDataLakeSettingsRequest":{
|
||||
"type":"structure",
|
||||
"required":["DataLakeSettings"],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. </p>"
|
||||
},
|
||||
"DataLakeSettings":{
|
||||
"shape":"DataLakeSettings",
|
||||
"documentation":"<p>A list of AWS Lake Formation principals.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PutDataLakeSettingsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"RegisterResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArnString",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to register.</p>"
|
||||
},
|
||||
"UseServiceLinkedRole":{
|
||||
"shape":"NullableBoolean",
|
||||
"documentation":"<p>Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog. </p>"
|
||||
},
|
||||
"RoleArn":{
|
||||
"shape":"IAMRoleArn",
|
||||
"documentation":"<p>The identifier for the role.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RegisterResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Resource":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Catalog":{
|
||||
"shape":"CatalogResource",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. </p>"
|
||||
},
|
||||
"Database":{
|
||||
"shape":"DatabaseResource",
|
||||
"documentation":"<p>The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. </p>"
|
||||
},
|
||||
"Table":{
|
||||
"shape":"TableResource",
|
||||
"documentation":"<p>The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. </p>"
|
||||
},
|
||||
"TableWithColumns":{
|
||||
"shape":"TableWithColumnsResource",
|
||||
"documentation":"<p>The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.</p>"
|
||||
},
|
||||
"DataLocation":{
|
||||
"shape":"DataLocationResource",
|
||||
"documentation":"<p>The location of an Amazon S3 path where permissions are granted or revoked. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure for the resource.</p>"
|
||||
},
|
||||
"ResourceArnString":{"type":"string"},
|
||||
"ResourceInfo":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArnString",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
|
||||
},
|
||||
"RoleArn":{
|
||||
"shape":"IAMRoleArn",
|
||||
"documentation":"<p>The IAM role that registered a resource.</p>"
|
||||
},
|
||||
"LastModified":{
|
||||
"shape":"LastModifiedTimestamp",
|
||||
"documentation":"<p>The date and time the resource was last modified.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure containing information about an AWS Lake Formation resource.</p>"
|
||||
},
|
||||
"ResourceInfoList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResourceInfo"}
|
||||
},
|
||||
"RevokePermissionsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Principal",
|
||||
"Resource",
|
||||
"Permissions"
|
||||
],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. </p>"
|
||||
},
|
||||
"Principal":{
|
||||
"shape":"DataLakePrincipal",
|
||||
"documentation":"<p>The principal to be revoked permissions on the resource.</p>"
|
||||
},
|
||||
"Resource":{
|
||||
"shape":"Resource",
|
||||
"documentation":"<p>The resource to which permissions are to be revoked.</p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>The permissions revoked to the principal on the resource. For information about permissions, see <a href=\"https://docs-aws.amazon.com/michigan/latest/dg/security-data-access.html\">Security and Access Control to Metadata and Data</a>.</p>"
|
||||
},
|
||||
"PermissionsWithGrantOption":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RevokePermissionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"StringValue":{"type":"string"},
|
||||
"StringValueList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StringValue"}
|
||||
},
|
||||
"TableResource":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"Name"
|
||||
],
|
||||
"members":{
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. </p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the table.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. </p>"
|
||||
},
|
||||
"TableWithColumnsResource":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. </p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. </p>"
|
||||
},
|
||||
"ColumnNames":{
|
||||
"shape":"ColumnNames",
|
||||
"documentation":"<p>The list of column names for the table. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</p>"
|
||||
},
|
||||
"ColumnWildcard":{
|
||||
"shape":"ColumnWildcard",
|
||||
"documentation":"<p>A wildcard specified by a <code>ColumnWildcard</code> object. At least one of <code>ColumnNames</code> or <code>ColumnWildcard</code> is required.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure for a table with columns object. This object is only used when granting a SELECT permission.</p> <p>This object must take a value for at least one of <code>ColumnsNames</code>, <code>ColumnsIndexes</code>, or <code>ColumnsWildcard</code>.</p>"
|
||||
},
|
||||
"Token":{"type":"string"},
|
||||
"UpdateResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"RoleArn",
|
||||
"ResourceArn"
|
||||
],
|
||||
"members":{
|
||||
"RoleArn":{
|
||||
"shape":"IAMRoleArn",
|
||||
"documentation":"<p>The new role to use for the given resource registered in AWS Lake Formation.</p>"
|
||||
},
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArnString",
|
||||
"documentation":"<p>The resource ARN.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>AWS Lake Formation</fullname> <p>Defines the public endpoint for the AWS Lake Formation service.</p>"
|
||||
}
|
||||
|
|
@ -12,6 +12,39 @@
|
|||
"uid":"runtime.lex-2016-11-28"
|
||||
},
|
||||
"operations":{
|
||||
"DeleteSession":{
|
||||
"name":"DeleteSession",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/session"
|
||||
},
|
||||
"input":{"shape":"DeleteSessionRequest"},
|
||||
"output":{"shape":"DeleteSessionResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"ConflictException"}
|
||||
],
|
||||
"documentation":"<p>Removes session information for a specified bot, alias, and user ID. </p>"
|
||||
},
|
||||
"GetSession":{
|
||||
"name":"GetSession",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/session"
|
||||
},
|
||||
"input":{"shape":"GetSessionRequest"},
|
||||
"output":{"shape":"GetSessionResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Returns session information for a specified bot, alias, and user ID.</p>"
|
||||
},
|
||||
"PostContent":{
|
||||
"name":"PostContent",
|
||||
"http":{
|
||||
|
|
@ -33,7 +66,7 @@
|
|||
{"shape":"BadGatewayException"},
|
||||
{"shape":"LoopDetectedException"}
|
||||
],
|
||||
"documentation":"<p> Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot. </p> <p>The <code>PostContent</code> operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications. </p> <p> In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages: </p> <ul> <li> <p> For a user input \"I would like a pizza,\" Amazon Lex might return a response with a message eliciting slot data (for example, <code>PizzaSize</code>): \"What size pizza would you like?\". </p> </li> <li> <p> After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: \"Order the pizza?\". </p> </li> <li> <p> After the user replies \"Yes\" to the confirmation prompt, Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\". </p> </li> </ul> <p> Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the <code>message</code>, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples: </p> <ul> <li> <p> If the message is to elicit slot data, Amazon Lex returns the following context information: </p> <ul> <li> <p> <code>x-amz-lex-dialog-state</code> header set to <code>ElicitSlot</code> </p> </li> <li> <p> <code>x-amz-lex-intent-name</code> header set to the intent name in the current context </p> </li> <li> <p> <code>x-amz-lex-slot-to-elicit</code> header set to the slot name for which the <code>message</code> is eliciting information </p> </li> <li> <p> <code>x-amz-lex-slots</code> header set to a map of slots configured for the intent with their current values </p> </li> </ul> </li> <li> <p> If the message is a confirmation prompt, the <code>x-amz-lex-dialog-state</code> header is set to <code>Confirmation</code> and the <code>x-amz-lex-slot-to-elicit</code> header is omitted. </p> </li> <li> <p> If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the <code>x-amz-dialog-state</code> header is set to <code>ElicitIntent</code> and the <code>x-amz-slot-to-elicit</code> header is omitted. </p> </li> </ul> <p> In addition, Amazon Lex also returns your application-specific <code>sessionAttributes</code>. For more information, see <a href=\"http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html\">Managing Conversation Context</a>. </p>",
|
||||
"documentation":"<p> Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot. </p> <p>The <code>PostContent</code> operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications. </p> <p> In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages: </p> <ul> <li> <p> For a user input \"I would like a pizza,\" Amazon Lex might return a response with a message eliciting slot data (for example, <code>PizzaSize</code>): \"What size pizza would you like?\". </p> </li> <li> <p> After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: \"Order the pizza?\". </p> </li> <li> <p> After the user replies \"Yes\" to the confirmation prompt, Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\". </p> </li> </ul> <p> Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the <code>message</code>, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples: </p> <ul> <li> <p> If the message is to elicit slot data, Amazon Lex returns the following context information: </p> <ul> <li> <p> <code>x-amz-lex-dialog-state</code> header set to <code>ElicitSlot</code> </p> </li> <li> <p> <code>x-amz-lex-intent-name</code> header set to the intent name in the current context </p> </li> <li> <p> <code>x-amz-lex-slot-to-elicit</code> header set to the slot name for which the <code>message</code> is eliciting information </p> </li> <li> <p> <code>x-amz-lex-slots</code> header set to a map of slots configured for the intent with their current values </p> </li> </ul> </li> <li> <p> If the message is a confirmation prompt, the <code>x-amz-lex-dialog-state</code> header is set to <code>Confirmation</code> and the <code>x-amz-lex-slot-to-elicit</code> header is omitted. </p> </li> <li> <p> If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the <code>x-amz-dialog-state</code> header is set to <code>ElicitIntent</code> and the <code>x-amz-slot-to-elicit</code> header is omitted. </p> </li> </ul> <p> In addition, Amazon Lex also returns your application-specific <code>sessionAttributes</code>. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html\">Managing Conversation Context</a>. </p>",
|
||||
"authtype":"v4-unsigned-body"
|
||||
},
|
||||
"PostText":{
|
||||
|
|
@ -54,7 +87,27 @@
|
|||
{"shape":"BadGatewayException"},
|
||||
{"shape":"LoopDetectedException"}
|
||||
],
|
||||
"documentation":"<p>Sends user input (text-only) to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot. </p> <p> In response, Amazon Lex returns the next <code>message</code> to convey to the user an optional <code>responseCard</code> to display. Consider the following example messages: </p> <ul> <li> <p> For a user input \"I would like a pizza\", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): \"What size pizza would you like?\" </p> </li> <li> <p> After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation \"Proceed with the pizza order?\". </p> </li> <li> <p> After the user replies to a confirmation prompt with a \"yes\", Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\". </p> </li> </ul> <p> Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a \"yes\" or \"no\" user response. In addition to the <code>message</code>, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the <code>slotToElicit</code>, <code>dialogState</code>, <code>intentName</code>, and <code>slots</code> fields in the response. Consider the following examples: </p> <ul> <li> <p>If the message is to elicit slot data, Amazon Lex returns the following context information:</p> <ul> <li> <p> <code>dialogState</code> set to ElicitSlot </p> </li> <li> <p> <code>intentName</code> set to the intent name in the current context </p> </li> <li> <p> <code>slotToElicit</code> set to the slot name for which the <code>message</code> is eliciting information </p> </li> <li> <p> <code>slots</code> set to a map of slots, configured for the intent, with currently known values </p> </li> </ul> </li> <li> <p> If the message is a confirmation prompt, the <code>dialogState</code> is set to ConfirmIntent and <code>SlotToElicit</code> is set to null. </p> </li> <li> <p>If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the <code>dialogState</code> is set to ElicitIntent and <code>slotToElicit</code> is set to null. </p> </li> </ul> <p> In addition, Amazon Lex also returns your application-specific <code>sessionAttributes</code>. For more information, see <a href=\"http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html\">Managing Conversation Context</a>. </p>"
|
||||
"documentation":"<p>Sends user input (text or SSML) to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot. </p> <p> In response, Amazon Lex returns the next <code>message</code> to convey to the user an optional <code>responseCard</code> to display. Consider the following example messages: </p> <ul> <li> <p> For a user input \"I would like a pizza\", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): \"What size pizza would you like?\" </p> </li> <li> <p> After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation \"Proceed with the pizza order?\". </p> </li> <li> <p> After the user replies to a confirmation prompt with a \"yes\", Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\". </p> </li> </ul> <p> Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a \"yes\" or \"no\" user response. In addition to the <code>message</code>, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the <code>slotToElicit</code>, <code>dialogState</code>, <code>intentName</code>, and <code>slots</code> fields in the response. Consider the following examples: </p> <ul> <li> <p>If the message is to elicit slot data, Amazon Lex returns the following context information:</p> <ul> <li> <p> <code>dialogState</code> set to ElicitSlot </p> </li> <li> <p> <code>intentName</code> set to the intent name in the current context </p> </li> <li> <p> <code>slotToElicit</code> set to the slot name for which the <code>message</code> is eliciting information </p> </li> <li> <p> <code>slots</code> set to a map of slots, configured for the intent, with currently known values </p> </li> </ul> </li> <li> <p> If the message is a confirmation prompt, the <code>dialogState</code> is set to ConfirmIntent and <code>SlotToElicit</code> is set to null. </p> </li> <li> <p>If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the <code>dialogState</code> is set to ElicitIntent and <code>slotToElicit</code> is set to null. </p> </li> </ul> <p> In addition, Amazon Lex also returns your application-specific <code>sessionAttributes</code>. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html\">Managing Conversation Context</a>. </p>"
|
||||
},
|
||||
"PutSession":{
|
||||
"name":"PutSession",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/session"
|
||||
},
|
||||
"input":{"shape":"PutSessionRequest"},
|
||||
"output":{"shape":"PutSessionResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"NotAcceptableException"},
|
||||
{"shape":"DependencyFailedException"},
|
||||
{"shape":"BadGatewayException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html\">Managing Sessions</a>.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -115,6 +168,14 @@
|
|||
"max":1000,
|
||||
"min":1
|
||||
},
|
||||
"ConfirmationStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"None",
|
||||
"Confirmed",
|
||||
"Denied"
|
||||
]
|
||||
},
|
||||
"ConflictException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -128,6 +189,55 @@
|
|||
"type":"string",
|
||||
"enum":["application/vnd.amazonaws.card.generic"]
|
||||
},
|
||||
"DeleteSessionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"botName",
|
||||
"botAlias",
|
||||
"userId"
|
||||
],
|
||||
"members":{
|
||||
"botName":{
|
||||
"shape":"BotName",
|
||||
"documentation":"<p>The name of the bot that contains the session data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"botName"
|
||||
},
|
||||
"botAlias":{
|
||||
"shape":"BotAlias",
|
||||
"documentation":"<p>The alias in use for the bot that contains the session data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"botAlias"
|
||||
},
|
||||
"userId":{
|
||||
"shape":"UserId",
|
||||
"documentation":"<p>The identifier of the user associated with the session data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"userId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteSessionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"botName":{
|
||||
"shape":"BotName",
|
||||
"documentation":"<p>The name of the bot associated with the session data.</p>"
|
||||
},
|
||||
"botAlias":{
|
||||
"shape":"BotAlias",
|
||||
"documentation":"<p>The alias in use for the bot associated with the session data.</p>"
|
||||
},
|
||||
"userId":{
|
||||
"shape":"UserId",
|
||||
"documentation":"<p>The ID of the client application user.</p>"
|
||||
},
|
||||
"sessionId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The unique identifier for the session.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DependencyFailedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -137,6 +247,51 @@
|
|||
"error":{"httpStatusCode":424},
|
||||
"exception":true
|
||||
},
|
||||
"DialogAction":{
|
||||
"type":"structure",
|
||||
"required":["type"],
|
||||
"members":{
|
||||
"type":{
|
||||
"shape":"DialogActionType",
|
||||
"documentation":"<p>The next action that the bot should take in its interaction with the user. The possible values are:</p> <ul> <li> <p> <code>ConfirmIntent</code> - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as \"Place the order?\"</p> </li> <li> <p> <code>Close</code> - Indicates that the there will not be a response from the user. For example, the statement \"Your order has been placed\" does not require a response.</p> </li> <li> <p> <code>Delegate</code> - The next action is determined by Amazon Lex.</p> </li> <li> <p> <code>ElicitIntent</code> - The next action is to determine the intent that the user wants to fulfill.</p> </li> <li> <p> <code>ElicitSlot</code> - The next action is to elicit a slot value from the user.</p> </li> </ul>"
|
||||
},
|
||||
"intentName":{
|
||||
"shape":"IntentName",
|
||||
"documentation":"<p>The name of the intent.</p>"
|
||||
},
|
||||
"slots":{
|
||||
"shape":"StringMap",
|
||||
"documentation":"<p>Map of the slots that have been gathered and their values. </p>"
|
||||
},
|
||||
"slotToElicit":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the slot that should be elicited from the user.</p>"
|
||||
},
|
||||
"fulfillmentState":{
|
||||
"shape":"FulfillmentState",
|
||||
"documentation":"<p>The fulfillment state of the intent. The possible values are:</p> <ul> <li> <p> <code>Failed</code> - The Lambda function associated with the intent failed to fulfill the intent.</p> </li> <li> <p> <code>Fulfilled</code> - The intent has fulfilled by the Lambda function associated with the intent. </p> </li> <li> <p> <code>ReadyForFulfillment</code> - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.</p> </li> </ul>"
|
||||
},
|
||||
"message":{
|
||||
"shape":"Text",
|
||||
"documentation":"<p>The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.</p>"
|
||||
},
|
||||
"messageFormat":{
|
||||
"shape":"MessageFormatType",
|
||||
"documentation":"<ul> <li> <p> <code>PlainText</code> - The message contains plain UTF-8 text.</p> </li> <li> <p> <code>CustomPayload</code> - The message is a custom format for the client.</p> </li> <li> <p> <code>SSML</code> - The message contains text formatted for voice output.</p> </li> <li> <p> <code>Composite</code> - The message contains an escaped JSON object containing one or more messages. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html\">Message Groups</a>. </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the <code>DialogAction</code> data type to set the interaction to a specific state, or to return the interaction to a previous state.</p>"
|
||||
},
|
||||
"DialogActionType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ElicitIntent",
|
||||
"ConfirmIntent",
|
||||
"ElicitSlot",
|
||||
"Close",
|
||||
"Delegate"
|
||||
]
|
||||
},
|
||||
"DialogState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -149,6 +304,14 @@
|
|||
]
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"FulfillmentState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"Fulfilled",
|
||||
"Failed",
|
||||
"ReadyForFulfillment"
|
||||
]
|
||||
},
|
||||
"GenericAttachment":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -175,8 +338,94 @@
|
|||
},
|
||||
"documentation":"<p>Represents an option rendered to the user when a prompt is shown. It could be an image, a button, a link, or text. </p>"
|
||||
},
|
||||
"GetSessionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"botName",
|
||||
"botAlias",
|
||||
"userId"
|
||||
],
|
||||
"members":{
|
||||
"botName":{
|
||||
"shape":"BotName",
|
||||
"documentation":"<p>The name of the bot that contains the session data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"botName"
|
||||
},
|
||||
"botAlias":{
|
||||
"shape":"BotAlias",
|
||||
"documentation":"<p>The alias in use for the bot that contains the session data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"botAlias"
|
||||
},
|
||||
"userId":{
|
||||
"shape":"UserId",
|
||||
"documentation":"<p>The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"userId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetSessionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"recentIntentSummaryView":{
|
||||
"shape":"IntentSummaryList",
|
||||
"documentation":"<p>An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the <code>recentIntentSummaryView</code> operation contains information about the last three intents used.</p>"
|
||||
},
|
||||
"sessionAttributes":{
|
||||
"shape":"StringMap",
|
||||
"documentation":"<p>Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.</p>"
|
||||
},
|
||||
"sessionId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A unique identifier for the session.</p>"
|
||||
},
|
||||
"dialogAction":{
|
||||
"shape":"DialogAction",
|
||||
"documentation":"<p>Describes the current state of the bot.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"HttpContentType":{"type":"string"},
|
||||
"IntentName":{"type":"string"},
|
||||
"IntentSummary":{
|
||||
"type":"structure",
|
||||
"required":["dialogActionType"],
|
||||
"members":{
|
||||
"intentName":{
|
||||
"shape":"IntentName",
|
||||
"documentation":"<p>The name of the intent.</p>"
|
||||
},
|
||||
"slots":{
|
||||
"shape":"StringMap",
|
||||
"documentation":"<p>Map of the slots that have been gathered and their values. </p>"
|
||||
},
|
||||
"confirmationStatus":{
|
||||
"shape":"ConfirmationStatus",
|
||||
"documentation":"<p>The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to <code>Confirmed</code>. If the user denies the intent, Amazon Lex sets this value to <code>Denied</code>. The possible values are:</p> <ul> <li> <p> <code>Confirmed</code> - The user has responded \"Yes\" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.</p> </li> <li> <p> <code>Denied</code> - The user has responded \"No\" to the confirmation prompt.</p> </li> <li> <p> <code>None</code> - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.</p> </li> </ul>"
|
||||
},
|
||||
"dialogActionType":{
|
||||
"shape":"DialogActionType",
|
||||
"documentation":"<p>The next action that the bot should take in its interaction with the user. The possible values are:</p> <ul> <li> <p> <code>ConfirmIntent</code> - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as \"Place the order?\"</p> </li> <li> <p> <code>Close</code> - Indicates that the there will not be a response from the user. For example, the statement \"Your order has been placed\" does not require a response.</p> </li> <li> <p> <code>ElicitIntent</code> - The next action is to determine the intent that the user wants to fulfill.</p> </li> <li> <p> <code>ElicitSlot</code> - The next action is to elicit a slot value from the user.</p> </li> </ul>"
|
||||
},
|
||||
"fulfillmentState":{
|
||||
"shape":"FulfillmentState",
|
||||
"documentation":"<p>The fulfillment state of the intent. The possible values are:</p> <ul> <li> <p> <code>Failed</code> - The Lambda function associated with the intent failed to fulfill the intent.</p> </li> <li> <p> <code>Fulfilled</code> - The intent has fulfilled by the Lambda function associated with the intent. </p> </li> <li> <p> <code>ReadyForFulfillment</code> - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.</p> </li> </ul>"
|
||||
},
|
||||
"slotToElicit":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The next slot to elicit from the user. If there is not slot to elicit, the field is blank.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.</p>"
|
||||
},
|
||||
"IntentSummaryList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"IntentSummary"},
|
||||
"max":3,
|
||||
"min":0
|
||||
},
|
||||
"InternalFailureException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -267,14 +516,14 @@
|
|||
},
|
||||
"sessionAttributes":{
|
||||
"shape":"AttributesString",
|
||||
"documentation":"<p>You pass this value as the <code>x-amz-lex-session-attributes</code> HTTP header.</p> <p>Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the <code>sessionAttributes</code> and <code>requestAttributes</code> headers is limited to 12 KB.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs\">Setting Session Attributes</a>.</p>",
|
||||
"documentation":"<p>You pass this value as the <code>x-amz-lex-session-attributes</code> HTTP header.</p> <p>Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the <code>sessionAttributes</code> and <code>requestAttributes</code> headers is limited to 12 KB.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs\">Setting Session Attributes</a>.</p>",
|
||||
"jsonvalue":true,
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-session-attributes"
|
||||
},
|
||||
"requestAttributes":{
|
||||
"shape":"AttributesString",
|
||||
"documentation":"<p>You pass this value as the <code>x-amz-lex-request-attributes</code> HTTP header.</p> <p>Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the <code>requestAttributes</code> and <code>sessionAttributes</code> headers is limited to 12 KB.</p> <p>The namespace <code>x-amz-lex:</code> is reserved for special attributes. Don't create any request attributes with the prefix <code>x-amz-lex:</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs\">Setting Request Attributes</a>.</p>",
|
||||
"documentation":"<p>You pass this value as the <code>x-amz-lex-request-attributes</code> HTTP header.</p> <p>Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the <code>requestAttributes</code> and <code>sessionAttributes</code> headers is limited to 12 KB.</p> <p>The namespace <code>x-amz-lex:</code> is reserved for special attributes. Don't create any request attributes with the prefix <code>x-amz-lex:</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs\">Setting Request Attributes</a>.</p>",
|
||||
"jsonvalue":true,
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-request-attributes"
|
||||
|
|
@ -287,7 +536,7 @@
|
|||
},
|
||||
"accept":{
|
||||
"shape":"Accept",
|
||||
"documentation":"<p> You pass this value as the <code>Accept</code> HTTP header. </p> <p> The message Amazon Lex returns in the response can be either text or speech based on the <code>Accept</code> HTTP header value in the request. </p> <ul> <li> <p> If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex returns text in the response. </p> </li> <li> <p> If the value begins with <code>audio/</code>, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the <code>Accept</code> header). For example, if you specify <code>audio/mpeg</code> as the value, Amazon Lex returns speech in the MPEG format.</p> <p>The following are the accepted values:</p> <ul> <li> <p>audio/mpeg</p> </li> <li> <p>audio/ogg</p> </li> <li> <p>audio/pcm</p> </li> <li> <p>text/plain; charset=utf-8</p> </li> <li> <p>audio/* (defaults to mpeg)</p> </li> </ul> </li> </ul>",
|
||||
"documentation":"<p> You pass this value as the <code>Accept</code> HTTP header. </p> <p> The message Amazon Lex returns in the response can be either text or speech based on the <code>Accept</code> HTTP header value in the request. </p> <ul> <li> <p> If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex returns text in the response. </p> </li> <li> <p> If the value begins with <code>audio/</code>, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the <code>Accept</code> header). For example, if you specify <code>audio/mpeg</code> as the value, Amazon Lex returns speech in the MPEG format.</p> </li> <li> <p>If the value is <code>audio/pcm</code>, the speech returned is <code>audio/pcm</code> in 16-bit, little endian format. </p> </li> <li> <p>The following are the accepted values:</p> <ul> <li> <p>audio/mpeg</p> </li> <li> <p>audio/ogg</p> </li> <li> <p>audio/pcm</p> </li> <li> <p>text/plain; charset=utf-8</p> </li> <li> <p>audio/* (defaults to mpeg)</p> </li> </ul> </li> </ul>",
|
||||
"location":"header",
|
||||
"locationName":"Accept"
|
||||
},
|
||||
|
|
@ -315,7 +564,7 @@
|
|||
},
|
||||
"slots":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation.</p> <p>Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the <code>valueSelectionStrategy</code> selected when the slot type was created or updated. If <code>valueSelectionStrategy</code> is set to <code>ORIGINAL_VALUE</code>, the value provided by the user is returned, if the user value is similar to the slot values. If <code>valueSelectionStrategy</code> is set to <code>TOP_RESOLUTION</code> Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a <code>valueSelectionStrategy</code>, the default is <code>ORIGINAL_VALUE</code>.</p>",
|
||||
"documentation":"<p>Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.</p> <p>Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the <code>valueSelectionStrategy</code> selected when the slot type was created or updated. If <code>valueSelectionStrategy</code> is set to <code>ORIGINAL_VALUE</code>, the value provided by the user is returned, if the user value is similar to the slot values. If <code>valueSelectionStrategy</code> is set to <code>TOP_RESOLUTION</code> Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a <code>valueSelectionStrategy</code>, the default is <code>ORIGINAL_VALUE</code>.</p>",
|
||||
"jsonvalue":true,
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-slots"
|
||||
|
|
@ -329,7 +578,7 @@
|
|||
},
|
||||
"message":{
|
||||
"shape":"Text",
|
||||
"documentation":"<p>The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.</p> <p>If the intent is not configured with a Lambda function, or if the Lambda function returned <code>Delegate</code> as the <code>dialogAction.type</code> its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.</p> <p>When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see <a>msg-prompts-formats</a>.</p> <p>If the Lambda function returns a message, Amazon Lex passes it to the client in its response.</p>",
|
||||
"documentation":"<p>The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.</p> <p>If the intent is not configured with a Lambda function, or if the Lambda function returned <code>Delegate</code> as the <code>dialogAction.type</code> in its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.</p> <p>When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see <a>msg-prompts-formats</a>.</p> <p>If the Lambda function returns a message, Amazon Lex passes it to the client in its response.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-message"
|
||||
},
|
||||
|
|
@ -393,11 +642,11 @@
|
|||
},
|
||||
"sessionAttributes":{
|
||||
"shape":"StringMap",
|
||||
"documentation":"<p>Application-specific information passed between Amazon Lex and a client application.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs\">Setting Session Attributes</a>.</p>"
|
||||
"documentation":"<p>Application-specific information passed between Amazon Lex and a client application.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs\">Setting Session Attributes</a>.</p>"
|
||||
},
|
||||
"requestAttributes":{
|
||||
"shape":"StringMap",
|
||||
"documentation":"<p>Request-specific information passed between Amazon Lex and a client application.</p> <p>The namespace <code>x-amz-lex:</code> is reserved for special attributes. Don't create any request attributes with the prefix <code>x-amz-lex:</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs\">Setting Request Attributes</a>.</p>"
|
||||
"documentation":"<p>Request-specific information passed between Amazon Lex and a client application.</p> <p>The namespace <code>x-amz-lex:</code> is reserved for special attributes. Don't create any request attributes with the prefix <code>x-amz-lex:</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs\">Setting Request Attributes</a>.</p>"
|
||||
},
|
||||
"inputText":{
|
||||
"shape":"Text",
|
||||
|
|
@ -442,6 +691,114 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"PutSessionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"botName",
|
||||
"botAlias",
|
||||
"userId"
|
||||
],
|
||||
"members":{
|
||||
"botName":{
|
||||
"shape":"BotName",
|
||||
"documentation":"<p>The name of the bot that contains the session data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"botName"
|
||||
},
|
||||
"botAlias":{
|
||||
"shape":"BotAlias",
|
||||
"documentation":"<p>The alias in use for the bot that contains the session data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"botAlias"
|
||||
},
|
||||
"userId":{
|
||||
"shape":"UserId",
|
||||
"documentation":"<p>The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"userId"
|
||||
},
|
||||
"sessionAttributes":{
|
||||
"shape":"StringMap",
|
||||
"documentation":"<p>Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.</p>"
|
||||
},
|
||||
"dialogAction":{
|
||||
"shape":"DialogAction",
|
||||
"documentation":"<p>Sets the next action that the bot should take to fulfill the conversation.</p>"
|
||||
},
|
||||
"accept":{
|
||||
"shape":"Accept",
|
||||
"documentation":"<p>The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.</p> <ul> <li> <p>If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex returns text in the response.</p> </li> <li> <p>If the value begins with <code>audio/</code>, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify <code>audio/mpeg</code> as the value, Amazon Lex returns speech in the MPEG format.</p> </li> <li> <p>If the value is <code>audio/pcm</code>, the speech is returned as <code>audio/pcm</code> in 16-bit, little endian format.</p> </li> <li> <p>The following are the accepted values:</p> <ul> <li> <p> <code>audio/mpeg</code> </p> </li> <li> <p> <code>audio/ogg</code> </p> </li> <li> <p> <code>audio/pcm</code> </p> </li> <li> <p> <code>audio/*</code> (defaults to mpeg)</p> </li> <li> <p> <code>text/plain; charset=utf-8</code> </p> </li> </ul> </li> </ul>",
|
||||
"location":"header",
|
||||
"locationName":"Accept"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PutSessionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"contentType":{
|
||||
"shape":"HttpContentType",
|
||||
"documentation":"<p>Content type as specified in the <code>Accept</code> HTTP header in the request.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Content-Type"
|
||||
},
|
||||
"intentName":{
|
||||
"shape":"IntentName",
|
||||
"documentation":"<p>The name of the current intent.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-intent-name"
|
||||
},
|
||||
"slots":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.</p> <p>Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the <code>valueSelectionStrategy</code> selected when the slot type was created or updated. If <code>valueSelectionStrategy</code> is set to <code>ORIGINAL_VALUE</code>, the value provided by the user is returned, if the user value is similar to the slot values. If <code>valueSelectionStrategy</code> is set to <code>TOP_RESOLUTION</code> Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a <code>valueSelectionStrategy</code> the default is <code>ORIGINAL_VALUE</code>. </p>",
|
||||
"jsonvalue":true,
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-slots"
|
||||
},
|
||||
"sessionAttributes":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Map of key/value pairs representing session-specific context information.</p>",
|
||||
"jsonvalue":true,
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-session-attributes"
|
||||
},
|
||||
"message":{
|
||||
"shape":"Text",
|
||||
"documentation":"<p>The next message that should be presented to the user.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-message"
|
||||
},
|
||||
"messageFormat":{
|
||||
"shape":"MessageFormatType",
|
||||
"documentation":"<p>The format of the response message. One of the following values:</p> <ul> <li> <p> <code>PlainText</code> - The message contains plain UTF-8 text.</p> </li> <li> <p> <code>CustomPayload</code> - The message is a custom format for the client.</p> </li> <li> <p> <code>SSML</code> - The message contains text formatted for voice output.</p> </li> <li> <p> <code>Composite</code> - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.</p> </li> </ul>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-message-format"
|
||||
},
|
||||
"dialogState":{
|
||||
"shape":"DialogState",
|
||||
"documentation":"<p/> <ul> <li> <p> <code>ConfirmIntent</code> - Amazon Lex is expecting a \"yes\" or \"no\" response to confirm the intent before fulfilling an intent.</p> </li> <li> <p> <code>ElicitIntent</code> - Amazon Lex wants to elicit the user's intent.</p> </li> <li> <p> <code>ElicitSlot</code> - Amazon Lex is expecting the value of a slot for the current intent.</p> </li> <li> <p> <code>Failed</code> - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.</p> </li> <li> <p> <code>Fulfilled</code> - Conveys that the Lambda function has sucessfully fulfilled the intent.</p> </li> <li> <p> <code>ReadyForFulfillment</code> - Conveys that the client has to fulfill the intent.</p> </li> </ul>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-dialog-state"
|
||||
},
|
||||
"slotToElicit":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>If the <code>dialogState</code> is <code>ElicitSlot</code>, returns the name of the slot for which Amazon Lex is eliciting a value.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-slot-to-elicit"
|
||||
},
|
||||
"audioStream":{
|
||||
"shape":"BlobStream",
|
||||
"documentation":"<p>The audio version of the message to convey to the user.</p>"
|
||||
},
|
||||
"sessionId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A unique identifier for the session.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-lex-session-id"
|
||||
}
|
||||
},
|
||||
"payload":"audioStream"
|
||||
},
|
||||
"RequestTimeoutException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
|
|||
|
|
@ -1454,7 +1454,7 @@
|
|||
"StreamName": {
|
||||
"shape": "__stringPatternWS",
|
||||
"locationName": "streamName",
|
||||
"documentation": "Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal."
|
||||
"documentation": "Specify a label for this output audio stream. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting."
|
||||
}
|
||||
},
|
||||
"documentation": "Description of audio output"
|
||||
|
|
@ -1551,7 +1551,7 @@
|
|||
"documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio."
|
||||
},
|
||||
"ExternalAudioFileInput": {
|
||||
"shape": "__stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE",
|
||||
"shape": "__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE",
|
||||
"locationName": "externalAudioFileInput",
|
||||
"documentation": "Specifies audio data from an external file source."
|
||||
},
|
||||
|
|
@ -1849,7 +1849,7 @@
|
|||
"LanguageDescription": {
|
||||
"shape": "__string",
|
||||
"locationName": "languageDescription",
|
||||
"documentation": "Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal."
|
||||
"documentation": "Specify a label for this set of output captions. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting."
|
||||
}
|
||||
},
|
||||
"documentation": "Description of Caption output"
|
||||
|
|
@ -1875,7 +1875,7 @@
|
|||
"LanguageDescription": {
|
||||
"shape": "__string",
|
||||
"locationName": "languageDescription",
|
||||
"documentation": "Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal."
|
||||
"documentation": "Specify a label for this set of output captions. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting."
|
||||
}
|
||||
},
|
||||
"documentation": "Caption Description for preset"
|
||||
|
|
@ -2056,12 +2056,17 @@
|
|||
"EncryptionMethod": {
|
||||
"shape": "CmafEncryptionType",
|
||||
"locationName": "encryptionMethod",
|
||||
"documentation": "Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption."
|
||||
"documentation": "For DRM with CMAF, the encryption type is always sample AES."
|
||||
},
|
||||
"InitializationVectorInManifest": {
|
||||
"shape": "CmafInitializationVectorInManifest",
|
||||
"locationName": "initializationVectorInManifest",
|
||||
"documentation": "The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest."
|
||||
"documentation": "When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests."
|
||||
},
|
||||
"SpekeKeyProvider": {
|
||||
"shape": "SpekeKeyProviderCmaf",
|
||||
"locationName": "spekeKeyProvider",
|
||||
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is CMAF. If your output group type is HLS, MS Smooth, or DASH, use the SpekeKeyProvider settings instead."
|
||||
},
|
||||
"StaticKeyProvider": {
|
||||
"shape": "StaticKeyProvider",
|
||||
|
|
@ -2071,14 +2076,14 @@
|
|||
"Type": {
|
||||
"shape": "CmafKeyProviderType",
|
||||
"locationName": "type",
|
||||
"documentation": "Indicates which type of key provider is used for encryption."
|
||||
"documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html."
|
||||
}
|
||||
},
|
||||
"documentation": "Settings for CMAF encryption"
|
||||
},
|
||||
"CmafEncryptionType": {
|
||||
"type": "string",
|
||||
"documentation": "Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.",
|
||||
"documentation": "For DRM with CMAF, the encryption type is always sample AES.",
|
||||
"enum": [
|
||||
"SAMPLE_AES"
|
||||
]
|
||||
|
|
@ -2171,7 +2176,7 @@
|
|||
},
|
||||
"CmafInitializationVectorInManifest": {
|
||||
"type": "string",
|
||||
"documentation": "The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.",
|
||||
"documentation": "When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.",
|
||||
"enum": [
|
||||
"INCLUDE",
|
||||
"EXCLUDE"
|
||||
|
|
@ -2179,8 +2184,9 @@
|
|||
},
|
||||
"CmafKeyProviderType": {
|
||||
"type": "string",
|
||||
"documentation": "Indicates which type of key provider is used for encryption.",
|
||||
"documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.",
|
||||
"enum": [
|
||||
"SPEKE",
|
||||
"STATIC_KEY"
|
||||
]
|
||||
},
|
||||
|
|
@ -2243,7 +2249,7 @@
|
|||
"ColorSpaceConversion": {
|
||||
"shape": "ColorSpaceConversion",
|
||||
"locationName": "colorSpaceConversion",
|
||||
"documentation": "Determines if colorspace conversion will be performed. If set to _None_, no conversion will be performed. If _Force 601_ or _Force 709_ are selected, conversion will be performed for inputs with differing colorspaces. An input's colorspace can be specified explicitly in the \"Video Selector\":#inputs-video_selector if necessary."
|
||||
"documentation": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output."
|
||||
},
|
||||
"Contrast": {
|
||||
"shape": "__integerMin1Max100",
|
||||
|
|
@ -2253,7 +2259,7 @@
|
|||
"Hdr10Metadata": {
|
||||
"shape": "Hdr10Metadata",
|
||||
"locationName": "hdr10Metadata",
|
||||
"documentation": "Use the HDR master display (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. Note that these settings are not color correction."
|
||||
"documentation": "Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr."
|
||||
},
|
||||
"Hue": {
|
||||
"shape": "__integerMinNegative180Max180",
|
||||
|
|
@ -2270,7 +2276,7 @@
|
|||
},
|
||||
"ColorMetadata": {
|
||||
"type": "string",
|
||||
"documentation": "Enable Insert color metadata (ColorMetadata) to include color metadata in this output. This setting is enabled by default.",
|
||||
"documentation": "Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.",
|
||||
"enum": [
|
||||
"IGNORE",
|
||||
"INSERT"
|
||||
|
|
@ -2278,7 +2284,7 @@
|
|||
},
|
||||
"ColorSpace": {
|
||||
"type": "string",
|
||||
"documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value FOLLOW. The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, or if your input video is missing color space metadata that should be there, specify the accurate color space here. If you choose HDR10, you can also correct inaccurate color space coefficients, using the HDR master display information controls. You must also set Color space usage (ColorSpaceUsage) to FORCE for the service to use these values.",
|
||||
"documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.",
|
||||
"enum": [
|
||||
"FOLLOW",
|
||||
"REC_601",
|
||||
|
|
@ -2289,7 +2295,7 @@
|
|||
},
|
||||
"ColorSpaceConversion": {
|
||||
"type": "string",
|
||||
"documentation": "Determines if colorspace conversion will be performed. If set to _None_, no conversion will be performed. If _Force 601_ or _Force 709_ are selected, conversion will be performed for inputs with differing colorspaces. An input's colorspace can be specified explicitly in the \"Video Selector\":#inputs-video_selector if necessary.",
|
||||
"documentation": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output.",
|
||||
"enum": [
|
||||
"NONE",
|
||||
"FORCE_601",
|
||||
|
|
@ -2300,7 +2306,7 @@
|
|||
},
|
||||
"ColorSpaceUsage": {
|
||||
"type": "string",
|
||||
"documentation": "There are two sources for color metadata, the input file and the job configuration (in the Color space and HDR master display informaiton settings). The Color space usage setting controls which takes precedence. FORCE: The system will use color metadata supplied by user, if any. If the user does not supply color metadata, the system will use data from the source. FALLBACK: The system will use color metadata from the source. If source has no color metadata, the system will use user-supplied color metadata values if available.",
|
||||
"documentation": "There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). The Color space usage setting determines which takes precedence. Choose Force (FORCE) to use color metadata from the input job settings. If you don't specify values for those settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use color metadata from the source when it is present. If there's no color metadata in your input file, the service defaults to using values you specify in the input settings.",
|
||||
"enum": [
|
||||
"FORCE",
|
||||
"FALLBACK"
|
||||
|
|
@ -2580,6 +2586,11 @@
|
|||
"locationName": "reservationPlanSettings",
|
||||
"documentation": "Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues."
|
||||
},
|
||||
"Status": {
|
||||
"shape": "QueueStatus",
|
||||
"locationName": "status",
|
||||
"documentation": "Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin."
|
||||
},
|
||||
"Tags": {
|
||||
"shape": "__mapOf__string",
|
||||
"locationName": "tags",
|
||||
|
|
@ -2611,7 +2622,7 @@
|
|||
"SpekeKeyProvider": {
|
||||
"shape": "SpekeKeyProvider",
|
||||
"locationName": "spekeKeyProvider",
|
||||
"documentation": "Settings for use with a SPEKE key provider"
|
||||
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
|
||||
}
|
||||
},
|
||||
"documentation": "Specifies DRM settings for DASH outputs."
|
||||
|
|
@ -3528,12 +3539,12 @@
|
|||
"Destination608ChannelNumber": {
|
||||
"shape": "__integerMin1Max4",
|
||||
"locationName": "destination608ChannelNumber",
|
||||
"documentation": "Ignore this setting unless your input captions are SCC format. With SCC inputs, you can optionally use this setting to replace the input channel number with the channel number that you specify. Specify a different number for each output captions track for a particular output. If you don't specify an output channel number, the system uses the input channel number for the output channel number. You can optionally combine two captions channels in your output. The two output channel numbers can be one of the following pairs: 1,3; 2,4; 1,4; or 2,3."
|
||||
"documentation": "Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video stream. Specify a CC number for each captions channel in this output. If you have two channels, pick CC numbers that aren't in the same field. For example, choose 1 and 3. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded."
|
||||
},
|
||||
"Destination708ServiceNumber": {
|
||||
"shape": "__integerMin1Max6",
|
||||
"locationName": "destination708ServiceNumber",
|
||||
"documentation": "Ignore this setting unless your input captions are SCC format and you are performing SCC upconvert. With SCC inputs, you can optionally use this setting to specify the 708 service number that is in the output. Specify a different service number for each output captions track for a particular output. If you don't specify an output track number, the system uses the 608 channel number for the output 708 service number. You can combine two captions channels in your output. Service numbers must be distinct."
|
||||
"documentation": "Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number you specify for CC channel number (destination608ChannelNumber) for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded."
|
||||
}
|
||||
},
|
||||
"documentation": "Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number."
|
||||
|
|
@ -4005,10 +4016,11 @@
|
|||
},
|
||||
"H264SceneChangeDetect": {
|
||||
"type": "string",
|
||||
"documentation": "Scene change detection (inserts I-frames on scene changes).",
|
||||
"documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.",
|
||||
"enum": [
|
||||
"DISABLED",
|
||||
"ENABLED"
|
||||
"ENABLED",
|
||||
"TRANSITION_DETECTION"
|
||||
]
|
||||
},
|
||||
"H264Settings": {
|
||||
|
|
@ -4167,7 +4179,7 @@
|
|||
"SceneChangeDetect": {
|
||||
"shape": "H264SceneChangeDetect",
|
||||
"locationName": "sceneChangeDetect",
|
||||
"documentation": "Scene change detection (inserts I-frames on scene changes)."
|
||||
"documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr."
|
||||
},
|
||||
"Slices": {
|
||||
"shape": "__integerMin1Max32",
|
||||
|
|
@ -4365,7 +4377,7 @@
|
|||
},
|
||||
"H265InterlaceMode": {
|
||||
"type": "string",
|
||||
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.",
|
||||
"documentation": "Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". If the source is progressive, your output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE).",
|
||||
"enum": [
|
||||
"PROGRESSIVE",
|
||||
"TOP_FIELD",
|
||||
|
|
@ -4427,10 +4439,11 @@
|
|||
},
|
||||
"H265SceneChangeDetect": {
|
||||
"type": "string",
|
||||
"documentation": "Scene change detection (inserts I-frames on scene changes).",
|
||||
"documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.",
|
||||
"enum": [
|
||||
"DISABLED",
|
||||
"ENABLED"
|
||||
"ENABLED",
|
||||
"TRANSITION_DETECTION"
|
||||
]
|
||||
},
|
||||
"H265Settings": {
|
||||
|
|
@ -4524,7 +4537,7 @@
|
|||
"InterlaceMode": {
|
||||
"shape": "H265InterlaceMode",
|
||||
"locationName": "interlaceMode",
|
||||
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose."
|
||||
"documentation": "Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". If the source is progressive, your output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE)."
|
||||
},
|
||||
"MaxBitrate": {
|
||||
"shape": "__integerMin1000Max1466400000",
|
||||
|
|
@ -4584,7 +4597,7 @@
|
|||
"SceneChangeDetect": {
|
||||
"shape": "H265SceneChangeDetect",
|
||||
"locationName": "sceneChangeDetect",
|
||||
"documentation": "Scene change detection (inserts I-frames on scene changes)."
|
||||
"documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr."
|
||||
},
|
||||
"Slices": {
|
||||
"shape": "__integerMin1Max32",
|
||||
|
|
@ -4725,12 +4738,12 @@
|
|||
"MaxContentLightLevel": {
|
||||
"shape": "__integerMin0Max65535",
|
||||
"locationName": "maxContentLightLevel",
|
||||
"documentation": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter."
|
||||
"documentation": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content."
|
||||
},
|
||||
"MaxFrameAverageLightLevel": {
|
||||
"shape": "__integerMin0Max65535",
|
||||
"locationName": "maxFrameAverageLightLevel",
|
||||
"documentation": "Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter."
|
||||
"documentation": "Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content."
|
||||
},
|
||||
"MaxLuminance": {
|
||||
"shape": "__integerMin0Max2147483647",
|
||||
|
|
@ -4763,7 +4776,7 @@
|
|||
"documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction."
|
||||
}
|
||||
},
|
||||
"documentation": "Use the \"HDR master display information\" (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000; each increment represents 0.00002 in CIE1931 color coordinate. Note that these settings are not color correction. Note that if you are creating HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, you must use the following settings. Set \"MP4 packaging type\" (writeMp4PackagingType) to HVC1 (HVC1). Set \"Profile\" (H265Settings > codecProfile) to Main10/High (MAIN10_HIGH). Set \"Level\" (H265Settings > codecLevel) to 5 (LEVEL_5)."
|
||||
"documentation": "Use these settings to specify static color calibration metadata, as defined by SMPTE ST 2086. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator."
|
||||
},
|
||||
"HlsAdMarkers": {
|
||||
"type": "string",
|
||||
|
|
@ -4875,7 +4888,7 @@
|
|||
"SpekeKeyProvider": {
|
||||
"shape": "SpekeKeyProvider",
|
||||
"locationName": "spekeKeyProvider",
|
||||
"documentation": "Settings for use with a SPEKE key provider"
|
||||
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
|
||||
},
|
||||
"StaticKeyProvider": {
|
||||
"shape": "StaticKeyProvider",
|
||||
|
|
@ -4885,7 +4898,7 @@
|
|||
"Type": {
|
||||
"shape": "HlsKeyProviderType",
|
||||
"locationName": "type",
|
||||
"documentation": "Indicates which type of key provider is used for encryption."
|
||||
"documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html."
|
||||
}
|
||||
},
|
||||
"documentation": "Settings for HLS encryption"
|
||||
|
|
@ -5042,7 +5055,7 @@
|
|||
},
|
||||
"HlsKeyProviderType": {
|
||||
"type": "string",
|
||||
"documentation": "Indicates which type of key provider is used for encryption.",
|
||||
"documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.",
|
||||
"enum": [
|
||||
"SPEKE",
|
||||
"STATIC_KEY"
|
||||
|
|
@ -5215,7 +5228,7 @@
|
|||
"documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs."
|
||||
},
|
||||
"FileInput": {
|
||||
"shape": "__stringPatternHttpHttpsS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL",
|
||||
"shape": "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL",
|
||||
"locationName": "fileInput",
|
||||
"documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL."
|
||||
},
|
||||
|
|
@ -6991,7 +7004,7 @@
|
|||
},
|
||||
"Mpeg2SceneChangeDetect": {
|
||||
"type": "string",
|
||||
"documentation": "Scene change detection (inserts I-frames on scene changes).",
|
||||
"documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default.",
|
||||
"enum": [
|
||||
"DISABLED",
|
||||
"ENABLED"
|
||||
|
|
@ -7123,7 +7136,7 @@
|
|||
"SceneChangeDetect": {
|
||||
"shape": "Mpeg2SceneChangeDetect",
|
||||
"locationName": "sceneChangeDetect",
|
||||
"documentation": "Scene change detection (inserts I-frames on scene changes)."
|
||||
"documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default."
|
||||
},
|
||||
"SlowPal": {
|
||||
"shape": "Mpeg2SlowPal",
|
||||
|
|
@ -7213,7 +7226,7 @@
|
|||
"SpekeKeyProvider": {
|
||||
"shape": "SpekeKeyProvider",
|
||||
"locationName": "spekeKeyProvider",
|
||||
"documentation": "Settings for use with a SPEKE key provider"
|
||||
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
|
||||
}
|
||||
},
|
||||
"documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider."
|
||||
|
|
@ -7284,7 +7297,7 @@
|
|||
"Filter": {
|
||||
"shape": "NoiseReducerFilter",
|
||||
"locationName": "filter",
|
||||
"documentation": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain filter based on JND principles."
|
||||
"documentation": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal optimizes video quality for complex motion."
|
||||
},
|
||||
"FilterSettings": {
|
||||
"shape": "NoiseReducerFilterSettings",
|
||||
|
|
@ -7295,13 +7308,18 @@
|
|||
"shape": "NoiseReducerSpatialFilterSettings",
|
||||
"locationName": "spatialFilterSettings",
|
||||
"documentation": "Noise reducer filter settings for spatial filter."
|
||||
},
|
||||
"TemporalFilterSettings": {
|
||||
"shape": "NoiseReducerTemporalFilterSettings",
|
||||
"locationName": "temporalFilterSettings",
|
||||
"documentation": "Noise reducer filter settings for temporal filter."
|
||||
}
|
||||
},
|
||||
"documentation": "Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default. When you enable Noise reducer (NoiseReducer), you must also select a value for Noise reducer filter (NoiseReducerFilter)."
|
||||
},
|
||||
"NoiseReducerFilter": {
|
||||
"type": "string",
|
||||
"documentation": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain filter based on JND principles.",
|
||||
"documentation": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal optimizes video quality for complex motion.",
|
||||
"enum": [
|
||||
"BILATERAL",
|
||||
"MEAN",
|
||||
|
|
@ -7309,7 +7327,8 @@
|
|||
"LANCZOS",
|
||||
"SHARPEN",
|
||||
"CONSERVE",
|
||||
"SPATIAL"
|
||||
"SPATIAL",
|
||||
"TEMPORAL"
|
||||
]
|
||||
},
|
||||
"NoiseReducerFilterSettings": {
|
||||
|
|
@ -7344,6 +7363,27 @@
|
|||
},
|
||||
"documentation": "Noise reducer filter settings for spatial filter."
|
||||
},
|
||||
"NoiseReducerTemporalFilterSettings": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AggressiveMode": {
|
||||
"shape": "__integerMin0Max4",
|
||||
"locationName": "aggressiveMode",
|
||||
"documentation": "Use Aggressive mode for content that has complex motion. Higher values produce stronger temporal filtering. This filters highly complex scenes more aggressively and creates better VQ for low bitrate outputs."
|
||||
},
|
||||
"Speed": {
|
||||
"shape": "__integerMinNegative1Max3",
|
||||
"locationName": "speed",
|
||||
"documentation": "The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time, high setting improves transcode time at the cost of bit rate."
|
||||
},
|
||||
"Strength": {
|
||||
"shape": "__integerMin0Max16",
|
||||
"locationName": "strength",
|
||||
"documentation": "Relative strength of noise reducing filter. Higher values produce stronger filtering. Recommended Range: * [0 .. 2] for complexity reduction with minimal sharpness loss * [2 .. 8] for complexity reduction with image preservation * [8 .. 16] for noise reduction. Reduce noise combined high complexity reduction"
|
||||
}
|
||||
},
|
||||
"documentation": "Noise reducer filter settings for temporal filter."
|
||||
},
|
||||
"NotFoundException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -8059,25 +8099,56 @@
|
|||
"CertificateArn": {
|
||||
"shape": "__stringPatternArnAwsUsGovAcm",
|
||||
"locationName": "certificateArn",
|
||||
"documentation": "Optional AWS Certificate Manager ARN for a certificate to send to the keyprovider. The certificate holds a key used by the keyprovider to encrypt the keys in its response."
|
||||
"documentation": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here."
|
||||
},
|
||||
"ResourceId": {
|
||||
"shape": "__string",
|
||||
"locationName": "resourceId",
|
||||
"documentation": "The SPEKE-compliant server uses Resource ID (ResourceId) to identify content."
|
||||
"documentation": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content."
|
||||
},
|
||||
"SystemIds": {
|
||||
"shape": "__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12",
|
||||
"locationName": "systemIds",
|
||||
"documentation": "Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id."
|
||||
"documentation": "Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id. See\n https://dashif.org/identifiers/content_protection/ for more details."
|
||||
},
|
||||
"Url": {
|
||||
"shape": "__stringPatternHttps",
|
||||
"locationName": "url",
|
||||
"documentation": "Use URL (Url) to specify the SPEKE-compliant server that will provide keys for content."
|
||||
"documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content."
|
||||
}
|
||||
},
|
||||
"documentation": "Settings for use with a SPEKE key provider"
|
||||
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
|
||||
},
|
||||
"SpekeKeyProviderCmaf": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CertificateArn": {
|
||||
"shape": "__stringPatternArnAwsUsGovAcm",
|
||||
"locationName": "certificateArn",
|
||||
"documentation": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here."
|
||||
},
|
||||
"DashSignaledSystemIds": {
|
||||
"shape": "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12",
|
||||
"locationName": "dashSignaledSystemIds",
|
||||
"documentation": "Specify the DRM system IDs that you want signaled in the DASH manifest that MediaConvert creates as part of this CMAF package. The DASH manifest can currently signal up to three system IDs. For more information, see https://dashif.org/identifiers/content_protection/."
|
||||
},
|
||||
"HlsSignaledSystemIds": {
|
||||
"shape": "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12",
|
||||
"locationName": "hlsSignaledSystemIds",
|
||||
"documentation": "Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF package. The HLS manifest can currently signal only one system ID. For more information, see https://dashif.org/identifiers/content_protection/."
|
||||
},
|
||||
"ResourceId": {
|
||||
"shape": "__stringPatternW",
|
||||
"locationName": "resourceId",
|
||||
"documentation": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content."
|
||||
},
|
||||
"Url": {
|
||||
"shape": "__stringPatternHttps",
|
||||
"locationName": "url",
|
||||
"documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content."
|
||||
}
|
||||
},
|
||||
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is CMAF. If your output group type is HLS, MS Smooth, or DASH, use the SpekeKeyProvider settings instead."
|
||||
},
|
||||
"StaticKeyProvider": {
|
||||
"type": "structure",
|
||||
|
|
@ -8157,10 +8228,26 @@
|
|||
"shape": "__stringMin3Max3Pattern1809aFAF09aEAE",
|
||||
"locationName": "pageNumber",
|
||||
"documentation": "Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of Teletext data, do not use this field."
|
||||
},
|
||||
"PageTypes": {
|
||||
"shape": "__listOfTeletextPageType",
|
||||
"locationName": "pageTypes",
|
||||
"documentation": "Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type to the default value Subtitle (PAGE_TYPE_SUBTITLE). If you pass through the entire set of Teletext data, don't use this field. When you pass through a set of Teletext pages, your output has the same page types as your input."
|
||||
}
|
||||
},
|
||||
"documentation": "Settings for Teletext caption output"
|
||||
},
|
||||
"TeletextPageType": {
|
||||
"type": "string",
|
||||
"documentation": "A page type as defined in the standard ETSI EN 300 468, Table 94",
|
||||
"enum": [
|
||||
"PAGE_TYPE_INITIAL",
|
||||
"PAGE_TYPE_SUBTITLE",
|
||||
"PAGE_TYPE_ADDL_INFO",
|
||||
"PAGE_TYPE_PROGRAM_SCHEDULE",
|
||||
"PAGE_TYPE_HEARING_IMPAIRED_SUBTITLE"
|
||||
]
|
||||
},
|
||||
"TeletextSourceSettings": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -8563,7 +8650,7 @@
|
|||
"ColorMetadata": {
|
||||
"shape": "ColorMetadata",
|
||||
"locationName": "colorMetadata",
|
||||
"documentation": "Enable Insert color metadata (ColorMetadata) to include color metadata in this output. This setting is enabled by default."
|
||||
"documentation": "Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default."
|
||||
},
|
||||
"Crop": {
|
||||
"shape": "Rectangle",
|
||||
|
|
@ -8676,17 +8763,17 @@
|
|||
"ColorSpace": {
|
||||
"shape": "ColorSpace",
|
||||
"locationName": "colorSpace",
|
||||
"documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value FOLLOW. The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, or if your input video is missing color space metadata that should be there, specify the accurate color space here. If you choose HDR10, you can also correct inaccurate color space coefficients, using the HDR master display information controls. You must also set Color space usage (ColorSpaceUsage) to FORCE for the service to use these values."
|
||||
"documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr."
|
||||
},
|
||||
"ColorSpaceUsage": {
|
||||
"shape": "ColorSpaceUsage",
|
||||
"locationName": "colorSpaceUsage",
|
||||
"documentation": "There are two sources for color metadata, the input file and the job configuration (in the Color space and HDR master display informaiton settings). The Color space usage setting controls which takes precedence. FORCE: The system will use color metadata supplied by user, if any. If the user does not supply color metadata, the system will use data from the source. FALLBACK: The system will use color metadata from the source. If source has no color metadata, the system will use user-supplied color metadata values if available."
|
||||
"documentation": "There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). The Color space usage setting determines which takes precedence. Choose Force (FORCE) to use color metadata from the input job settings. If you don't specify values for those settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use color metadata from the source when it is present. If there's no color metadata in your input file, the service defaults to using values you specify in the input settings."
|
||||
},
|
||||
"Hdr10Metadata": {
|
||||
"shape": "Hdr10Metadata",
|
||||
"locationName": "hdr10Metadata",
|
||||
"documentation": "Use the \"HDR master display information\" (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000; each increment represents 0.00002 in CIE1931 color coordinate. Note that these settings are not color correction. Note that if you are creating HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, you must use the following settings. Set \"MP4 packaging type\" (writeMp4PackagingType) to HVC1 (HVC1). Set \"Profile\" (H265Settings > codecProfile) to Main10/High (MAIN10_HIGH). Set \"Level\" (H265Settings > codecLevel) to 5 (LEVEL_5)."
|
||||
"documentation": "Use these settings to provide HDR 10 metadata that is missing or inaccurate in your input video. Appropriate values vary depending on the input video and must be provided by a color grader. The color grader generates these values during the HDR 10 mastering process. The valid range for each of these settings is 0 to 50,000. Each increment represents 0.00002 in CIE1931 color coordinate. Related settings - When you specify these values, you must also set Color space (ColorSpace) to HDR 10 (HDR10). To specify whether the the values you specify here take precedence over the values in the metadata of your input file, set Color space usage (ColorSpaceUsage). To specify whether color metadata is included in an output, set Color metadata (ColorMetadata). For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr."
|
||||
},
|
||||
"Pid": {
|
||||
"shape": "__integerMin1Max2147483647",
|
||||
|
|
@ -8855,6 +8942,11 @@
|
|||
"min": 0,
|
||||
"max": 3600
|
||||
},
|
||||
"__integerMin0Max4": {
|
||||
"type": "integer",
|
||||
"min": 0,
|
||||
"max": 4
|
||||
},
|
||||
"__integerMin0Max47185920": {
|
||||
"type": "integer",
|
||||
"min": 0,
|
||||
|
|
@ -9100,6 +9192,11 @@
|
|||
"min": -180,
|
||||
"max": 180
|
||||
},
|
||||
"__integerMinNegative1Max3": {
|
||||
"type": "integer",
|
||||
"min": -1,
|
||||
"max": 3
|
||||
},
|
||||
"__integerMinNegative2147483648Max2147483647": {
|
||||
"type": "integer",
|
||||
"min": -2147483648,
|
||||
|
|
@ -9250,6 +9347,12 @@
|
|||
"shape": "Queue"
|
||||
}
|
||||
},
|
||||
"__listOfTeletextPageType": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "TeletextPageType"
|
||||
}
|
||||
},
|
||||
"__listOf__integerMin1Max2147483647": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -9280,6 +9383,12 @@
|
|||
"shape": "__stringMin1"
|
||||
}
|
||||
},
|
||||
"__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12"
|
||||
}
|
||||
},
|
||||
"__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -9389,6 +9498,12 @@
|
|||
"max": 32,
|
||||
"pattern": "^[0-9a-fA-F]{32}$"
|
||||
},
|
||||
"__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12": {
|
||||
"type": "string",
|
||||
"min": 36,
|
||||
"max": 36,
|
||||
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
|
||||
},
|
||||
"__stringMin3Max3Pattern1809aFAF09aEAE": {
|
||||
"type": "string",
|
||||
"min": 3,
|
||||
|
|
@ -9447,9 +9562,9 @@
|
|||
"type": "string",
|
||||
"pattern": "^(\\d+(\\/\\d+)*)$"
|
||||
},
|
||||
"__stringPatternHttpHttpsS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": {
|
||||
"__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": {
|
||||
"type": "string",
|
||||
"pattern": "^(http|https|s3)://([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))$"
|
||||
"pattern": "^(http|https|s3)://([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))$"
|
||||
},
|
||||
"__stringPatternHttps": {
|
||||
"type": "string",
|
||||
|
|
@ -9467,9 +9582,9 @@
|
|||
"type": "string",
|
||||
"pattern": "^s3:\\/\\/.*\\/(ASSETMAP.xml)?$"
|
||||
},
|
||||
"__stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": {
|
||||
"__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": {
|
||||
"type": "string",
|
||||
"pattern": "^(s3:\\/\\/)([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))$"
|
||||
"pattern": "^(s3:\\/\\/)([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))$"
|
||||
},
|
||||
"__stringPatternSNManifestConfirmConditionNotificationNS": {
|
||||
"type": "string",
|
||||
|
|
@ -9479,6 +9594,10 @@
|
|||
"type": "string",
|
||||
"pattern": "^\\s*<(.|\\n)*SignalProcessingNotification(.|\\n)*>\\s*$"
|
||||
},
|
||||
"__stringPatternW": {
|
||||
"type": "string",
|
||||
"pattern": "^[\\w-]+$"
|
||||
},
|
||||
"__stringPatternWS": {
|
||||
"type": "string",
|
||||
"pattern": "^[\\w\\s]*$"
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"OpsWorksCM",
|
||||
"serviceFullName":"AWS OpsWorks for Chef Automate",
|
||||
"serviceFullName":"AWS OpsWorks CM",
|
||||
"serviceId":"OpsWorksCM",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"opsworks-cm",
|
||||
|
|
|
|||
|
|
@ -912,7 +912,7 @@
|
|||
"shape":"CustomerStorageMessage",
|
||||
"resultWrapper":"DescribeStorageResult"
|
||||
},
|
||||
"documentation":"<p>Returns the total amount of snapshot usage and provisioned storage for a user in megabytes.</p>"
|
||||
"documentation":"<p>Returns the total amount of snapshot usage and provisioned storage in megabytes.</p>"
|
||||
},
|
||||
"DescribeTableRestoreStatus":{
|
||||
"name":"DescribeTableRestoreStatus",
|
||||
|
|
@ -2001,6 +2001,14 @@
|
|||
"shape":"ScheduleState",
|
||||
"documentation":"<p>The current state of the cluster snapshot schedule.</p>"
|
||||
},
|
||||
"ExpectedNextSnapshotScheduleTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled. </p>"
|
||||
},
|
||||
"ExpectedNextSnapshotScheduleTimeStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:</p> <ul> <li> <p>OnTrack - The next snapshot is expected to be taken on time. </p> </li> <li> <p>Pending - The next snapshot is pending to be taken. </p> </li> </ul>"
|
||||
},
|
||||
"ResizeInfo":{
|
||||
"shape":"ResizeInfo",
|
||||
"documentation":"<p>Returns the following:</p> <ul> <li> <p>AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.</p> </li> <li> <p>ResizeType: Returns ClassicResize</p> </li> </ul>"
|
||||
|
|
@ -5909,7 +5917,7 @@
|
|||
},
|
||||
"NodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The new node type for the nodes you are adding.</p>"
|
||||
"documentation":"<p>The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.</p>"
|
||||
},
|
||||
"NumberOfNodes":{
|
||||
"shape":"Integer",
|
||||
|
|
|
|||
|
|
@ -1341,7 +1341,8 @@
|
|||
"DISGUSTED",
|
||||
"SURPRISED",
|
||||
"CALM",
|
||||
"UNKNOWN"
|
||||
"UNKNOWN",
|
||||
"FEAR"
|
||||
]
|
||||
},
|
||||
"Emotions":{
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ copyright = u'2013, Mitch Garnaat'
|
|||
# The short X.Y version.
|
||||
version = '1.12.2'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.12.200'
|
||||
release = '1.12.208'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
|
|||
BIN
tests/unit/cfg/aws_config_badbytes
Normal file
BIN
tests/unit/cfg/aws_config_badbytes
Normal file
Binary file not shown.
|
|
@ -67,6 +67,11 @@ class TestConfigLoader(BaseEnvVar):
|
|||
with self.assertRaises(botocore.exceptions.ConfigParseError):
|
||||
raw_config_parse(filename)
|
||||
|
||||
def test_config_parse_error_bad_unicode(self):
|
||||
filename = path('aws_config_badbytes')
|
||||
with self.assertRaises(botocore.exceptions.ConfigParseError):
|
||||
raw_config_parse(filename)
|
||||
|
||||
def test_config_parse_error_filesystem_encoding_none(self):
|
||||
filename = path('aws_config_bad')
|
||||
with mock.patch('sys.getfilesystemencoding') as encoding:
|
||||
|
|
|
|||
Loading…
Reference in a new issue