From 29d44ebdd76da48cb6324e9aebb6246b97c186da Mon Sep 17 00:00:00 2001
From: AWS SDK for Go v2 automation user The name of the Auto Scaling group. This name must be unique per Region per account. The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation\n characters, digits, and upper and lowercased letters. You cannot use a colon (:) in the name. The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the Default: The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the Default: The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify If you specify Default: Valid values: The allocation strategy to apply to your On-Demand Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify. The following lists the valid values: Uses price to determine which instance types are the highest priority,\n launching the lowest priced instance types within an Availability Zone\n first. This is the default value for Auto Scaling groups that specify InstanceRequirements. You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling\n launches your highest priority instance types first. If all your On-Demand\n capacity cannot be fulfilled using your highest priority instance type, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance\n type, and so on. This is the default value for Auto Scaling groups that don't\n specify InstanceRequirements and cannot be used for groups\n that do. The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is launched first as your group scales. If you specify weights for the instance types in the overrides, the base capacity is\n measured in the same unit of measurement as the instance types. If you specify InstanceRequirements in the overrides, the base capacity is measured in\n the same unit of measurement as your group's desired capacity. Default: The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is launched first as your group scales. This number has the same unit of measurement as the group's desired capacity. If you\n change the default unit of measurement (number of instances) by specifying weighted\n capacity values in your launch template overrides list, or by changing the default\n desired capacity type setting of the group, you must specify this number using the same\n unit of measurement. Default: 0 Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond Default: Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond Default: 100 Indicates how to allocate instances across Spot Instance pools. If the allocation strategy is If the allocation strategy is Default: Valid values: The allocation strategy to apply to your Spot Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify. The following lists the valid values: Requests Spot Instances using pools that are optimally chosen based on the\n available Spot capacity. This strategy has the lowest risk of interruption.\n To give certain instance types a higher chance of launching first, use\n You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors\n the instance type priorities on a best effort basis but optimizes for\n capacity first. Note that if the On-Demand allocation strategy is set to\n Requests Spot Instances using the lowest priced pools within an\n Availability Zone, across the number of Spot pools that you specify for the\n Amazon EC2 Auto Scaling identifies the pools with the highest capacity availability for\n the number of instances that are launching. This means that we will request\n Spot Instances from the pools that we believe have the lowest chance of\n interruption in the near term. Amazon EC2 Auto Scaling then requests Spot Instances from\n the lowest priced of these pools. The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the overrides. Valid only\n when the Spot allocation strategy is Default: The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the overrides. Valid only\n when the Default: 2 The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide. \n \n \n Default: The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide. Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools. Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n Spot Fleet requests instances from all of the Spot Instance pools that you\n specify. Spot Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates. Default: The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide. \n \n \n Default: The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide. EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools. EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify. EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates. Default: The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide. \n \n \n Default: The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide. EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools. EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify. EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates. Default: The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed. For tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to turn on container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\t For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms: Linux platform version Windows platform version The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies on other containers in a task definition. When a dependency is\n\t\t\tdefined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to turn on container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\t For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms: Linux platform version Windows platform version Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide. Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe There are two service scheduler strategies available: \n \n You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\t If a service uses the If a service uses the If a service uses either the When creating a service that uses the When the service scheduler launches new tasks, it determines task placement. For information\n\t\t\tabout task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide. Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide. Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe There are two service scheduler strategies available: \n \n You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\t If a service uses the If a service uses the If a service uses either the When creating a service that uses the When the service scheduler launches new tasks, it determines task placement. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide. Retrieves the protection status of tasks in an Amazon ECS service. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in. A list of up to 100 task IDs or full ARN entries. A list of tasks with the following information. \n \n \n Any failures associated with the call. The task ARN. The protection status of the task. If scale-in protection is enabled for a task, the\n\t\t\tvalue is The epoch time when protection for the task will expire. An object representing the protection status details for a task. You can set the\n\t\t\tprotection status with the UpdateTaskProtection API and get the status\n\t\t\tof tasks with the GetTaskProtection API. The resource name for which to modify the account setting. If\n\t\t\t\t Fargate is transitioning from task count-based quotas to vCPU-based quotas. You can set\n\t\t\tthe name to The resource name for which to modify the account setting. If\n\t\t\t\t Fargate is transitioning from task count-based quotas to vCPU-based quotas. You can\n\t\t\tset the name to The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers. If you're using the EC2 launch type, this field is optional. Supported values\n\t\t\tare between If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate. 256 (.25 vCPU) - Available 512 (.5 vCPU) - Available 1024 (1 vCPU) - Available 2048 (2 vCPU) - Available 4096 (4 vCPU) - Available 8192 (8 vCPU) - Available This option requires Linux platform 16384 (16vCPU) - Available This option requires Linux platform The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers. If you're using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate. 256 (.25 vCPU) - Available 512 (.5 vCPU) - Available 1024 (1 vCPU) - Available 2048 (2 vCPU) - Available 4096 (4 vCPU) - Available 8192 (8 vCPU) - Available This option requires Linux platform 16384 (16vCPU) - Available This option requires Linux platform Updates the protection status of a task. You can set Task-protection, by default, expires after 2 hours at which point Amazon ECS unsets the\n\t\t\t\t You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\t To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the Amazon Elastic Container Service Developer Guide. This operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Amazon ECS container\n\t\t\t\t\tagent endpoint. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in. A list of up to 10 task IDs or full ARN entries. Specify If you set If you don’t specify the time, then the task is automatically protected for 120\n\t\t\tminutes (2 hours). A list of tasks with the following information. \n \n \n Any failures associated with the call. The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information. Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains. For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide.\n The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs. The endpoint for configuration service requests is region-specific: es.region.amazonaws.com.\n For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,\n see Regions and Endpoints. Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains. For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide.\n The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs. The endpoint for configuration service requests is region-specific: es.region.amazonaws.com.\n For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,\n see Regions and Endpoints. \n Container for response returned by\n Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. The name of the OpenSearch Service domain to provide access to. The account ID to grant access to. Container for request parameters to the Information about the account or service that was provided access to the\n domain. Container for response parameters to the The type of principal. The IAM principal that is allowed access to the domain. Information about an account or service that has access to an Amazon\n OpenSearch Service domain through the use of an interface VPC endpoint. Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the Developer Guide. Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the Developer Guide. Specifies the Auto-Tune options latest version. Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION. Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION. The total number of stages required for the configuration change. The progress details of a specific domain configuration change. \n Container for response returned by\n Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered. Creates an Amazon OpenSearch Service-managed VPC endpoint. The name of the Elasticsearch domain that you want to permanently delete. The Amazon Resource Name (ARN) of the domain to grant access to. Options to specify the subnets and security groups for the endpoint. Unique, case-sensitive identifier to ensure idempotency of the request. Container for the parameters to the Container for the parameters to the The status of the Elasticsearch domain being deleted. Information about the newly created VPC endpoint. The result of a Container for response parameters to the Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered. The name of the Elasticsearch domain that you want to permanently delete. Container for the parameters to the The status of the Elasticsearch domain being deleted. The result of a \n Container for response parameters to\n Deletes an Amazon OpenSearch Service-managed interface VPC endpoint. The unique identifier of the endpoint to be deleted. Deletes an Amazon OpenSearch Service-managed interface VPC endpoint. Information about the deleted endpoint, including its current status ( Container for response parameters to the Set this value to limit the number of results returned. If not specified, defaults to 100. Set this value to limit the number of results returned. If not specified, defaults to 100. Set this value to limit the number of results returned. If not specified, defaults to 100. Limits results to a maximum number of packages. Set this value to limit the number of results returned. If not specified, defaults to 100. Set this value to limit the number of results returned. If not specified, defaults to 100. Container for results from Describes one or more Amazon OpenSearch Service-managed VPC endpoints. The unique identifiers of the endpoints to get information about. Container for request parameters to the Information about each requested VPC endpoint. Any errors associated with the request. Container for response parameters to the \n Container for response returned by\n Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information. Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information. Status of the Encryption At Rest options for the specified Elasticsearch domain. Limits results to a maximum number of versions. Specifies the number of EC2 instances in the Elasticsearch domain. Limits results to a maximum number of domains. \n Set this value to limit the number of results returned.\n Value provided must be greater than 30 else it wont be honored.\n \n Set this value to limit the number of results returned.\n Value provided must be greater than 10 else it wont be honored.\n Limits results to a maximum number of packages. The result of a Retrieves information about each principal that is allowed to access a\n given Amazon OpenSearch Service domain through the use of an interface VPC endpoint. The name of the OpenSearch Service domain to retrieve access information for. Provides an identifier to allow retrieval of paginated results. Retrieves information about each principal that is allowed to access a\n given Amazon OpenSearch Service domain through the use of an interface VPC endpoint List of Provides an identifier to allow retrieval of paginated results. Container for response parameters to the Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region. Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain. Name of the ElasticSearch domain whose VPC endpoints are to be listed. Provides an identifier to allow retrieval of paginated results. Container for request parameters to the Provides list of Information about each endpoint associated with the domain. Container for response parameters to the Identifier to allow retrieval of paginated results. Container for request parameters to the Information about each endpoint. Provides an identifier to allow retrieval of paginated results. Container for response parameters to the Type of Log File, it can be one of the following:\n InService
state. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.0
secondsInService
state. For more\n information, see Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.0
secondslowest-price
, Amazon EC2 Auto Scaling uses price to determine the order,\n launching the lowest price first. prioritized
, Amazon EC2 Auto Scaling uses the priority that you assigned\n to each launch template override, launching the highest priority first. If all your\n On-Demand capacity cannot be fulfilled using your highest priority instance, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so\n on.lowest-price
for Auto Scaling groups that specify InstanceRequirements in the overrides and prioritized
for\n Auto Scaling groups that don't.lowest-price
| prioritized
\n \n
"
}
},
"OnDemandBaseCapacity": {
"target": "com.amazonaws.autoscaling#OnDemandBaseCapacity",
"traits": {
- "smithy.api#documentation": "0
\n OnDemandBaseCapacity
. Expressed as a number (for example,\n 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand\n Instances are used.100
\n OnDemandBaseCapacity
. Expressed as a number (for example,\n 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand\n Instances are used.lowest-price
, the Auto Scaling group launches\n instances using the Spot pools with the lowest price, and evenly allocates your\n instances across the number of Spot pools that you specify. capacity-optimized
(recommended), the Auto Scaling\n group launches instances using Spot pools that are optimally chosen based on the\n available Spot capacity. Alternatively, you can use\n capacity-optimized-prioritized
and set the order of instance types in\n the list of launch template overrides from highest to lowest priority (from first to\n last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best-effort basis\n but optimizes for capacity first. lowest-price
\n lowest-price
| capacity-optimized
|\n capacity-optimized-prioritized
\n \n
"
}
},
"SpotInstancePools": {
"target": "com.amazonaws.autoscaling#SpotInstancePools",
"traits": {
- "smithy.api#documentation": "capacity-optimized-prioritized
.prioritized
, the same priority is applied when fulfilling\n On-Demand capacity. This is not a valid value for Auto Scaling groups that specify\n InstanceRequirements.SpotInstancePools
property. To ensure that your desired\n capacity is met, you might receive Spot Instances from several pools. This\n is the default value, but it might lead to high interruption rates because\n this strategy only considers instance price and not available\n capacity.lowest-price
. Value must be in the\n range of 1–20.2
\n SpotAllocationStrategy
is lowest-price
. Value must be\n in the range of 1–20.InService
state. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.InService
state. For more\n information, see Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.lowestPrice
- Spot Fleet launches instances from the lowest-price Spot Instance pool\n that has available capacity. If the cheapest pool doesn't have available capacity, the\n Spot Instances come from the next cheapest pool that has available capacity. If a pool runs out\n of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next cheapest pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools.diversified
- Spot Fleet launches instances from all of the Spot Instance pools that you\n specify.capacityOptimized
(recommended) - Spot Fleet launches instances from Spot Instance pools\n with optimal capacity for the number of instances that are launching. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized
is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.lowestPrice
\n \n
\n \n capacityOptimizedPrioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized
is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.lowestPrice
\n lowest-price
- EC2 Fleet launches instances from the lowest-price Spot Instance pool that\n has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances\n come from the next cheapest pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next cheapest pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools.diversified
- EC2 Fleet launches instances from all of the Spot Instance pools that you\n specify.capacity-optimized
(recommended) - EC2 Fleet launches instances from Spot Instance pools\n with optimal capacity for the number of instances that are launching. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized
is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.lowest-price
\n \n
\n \n capacity-optimized-prioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized
is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.lowest-price
\n lowest-price
- EC2 Fleet launches instances from the lowest-price Spot Instance pool that\n has available capacity. If the cheapest pool doesn't have available capacity, the Spot Instances\n come from the next cheapest pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next cheapest pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools.diversified
- EC2 Fleet launches instances from all\n of the Spot Instance pools that you specify.capacity-optimized
(recommended) - EC2 Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances that\n are launching. To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized
is supported only if your fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.lowest-price
\n \n
\n \n capacity-optimized-prioritized
. Set a priority for each instance type by\n using the Priority
parameter for LaunchTemplateOverrides
. You can\n assign the same priority to different LaunchTemplateOverrides
. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized
is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy
is set to\n prioritized
, the same priority is applied when fulfilling On-Demand\n capacity.lowest-price
\n ecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.\n
"
+ "smithy.api#documentation": "1.3.0
or later.1.0.0
or later.ecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.\n
"
}
},
"startTimeout": {
@@ -1928,7 +4048,7 @@
}
],
"traits": {
- "smithy.api#documentation": "1.3.0
or later.1.0.0
or later.desiredCount
,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.RUNNING
state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING
state and are reported as\n\t\t\thealthy by the load balancer.\n
\n\t\t REPLICA
- The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.DAEMON
- The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.minimumHealthyPercent
is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent
is 0%.ECS
deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING
state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING
state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING
state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING
state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.ECS
deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING
or\n\t\t\t\tPENDING
state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING
state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.CODE_DEPLOY
or EXTERNAL
\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING
state.\n\t\t\tThis is while the container instances are in the DRAINING
state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.EXTERNAL
deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.desiredCount
,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.RUNNING
state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING
state and are reported as\n\t\t\thealthy by the load balancer.\n
\n\t\t REPLICA
- The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.DAEMON
- The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.minimumHealthyPercent
is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent
is 0%.ECS
deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING
state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING
state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING
state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING
state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.ECS
deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING
or\n\t\t\t\tPENDING
state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING
state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.CODE_DEPLOY
or EXTERNAL
\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING
state.\n\t\t\tThis is while the container instances are in the DRAINING
state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.EXTERNAL
deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.\n
"
+ }
+ },
+ "failures": {
+ "target": "com.amazonaws.ecs#Failures",
+ "traits": {
+ "smithy.api#documentation": "taskArn
: The task ARN.protectionEnabled
: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is enabled for a task, the value is true
. Otherwise, it\n\t\t\t\t\tis false
.expirationDate
: The epoch time when protection for the task will\n\t\t\t\t\texpire.true
. Otherwise, it is false
.serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat
is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking
is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected. If containerInsights
is specified, the default\n\t\t\tsetting for CloudWatch Container Insights for your clusters is affected.fargateVCPULimit
to opt in or opt out of the vCPU-based quotas.\n\t\t\tFor information about the opt in timeline, see Fargate vCPU-based quotas timeline in the\n\t\t\t\tAmazon ECS Developer Guide.serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat
is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking
is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected. If containerInsights
is specified, the default\n\t\t\tsetting for CloudWatch Container Insights for your clusters is affected.fargateVCPULimit
to opt in or opt out of the vCPU-based\n\t\t\tquotas. For information about the opt in timeline, see Fargate vCPU-based quotas timeline in the\n\t\t\t\tAmazon ECS Developer Guide.1024
) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU
or 1 vcpu
) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.128
CPU units (0.125
vCPUs) and 10240
\n\t\t\tCPU units (10
vCPUs). If you do not specify a value, the parameter is\n\t\t\tignored.memory
parameter:\n
"
+ "smithy.api#documentation": "memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)memory
values: 16 GB and 60 GB in 4 GB increments1.4.0
or\n later.memory
values: 32GB and 120 GB in 8 GB increments1.4.0
or\n later.1024
) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU
or 1 vcpu
) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.128
CPU units (0.125
vCPUs) and\n\t\t\t\t10240
CPU units (10
vCPUs). If you do not specify a value,\n\t\t\tthe parameter is ignored.memory
parameter:\n
"
}
},
"memory": {
@@ -9688,6 +11911,91 @@
}
}
},
+ "com.amazonaws.ecs#UpdateTaskProtection": {
+ "type": "operation",
+ "input": {
+ "target": "com.amazonaws.ecs#UpdateTaskProtectionRequest"
+ },
+ "output": {
+ "target": "com.amazonaws.ecs#UpdateTaskProtectionResponse"
+ },
+ "errors": [
+ {
+ "target": "com.amazonaws.ecs#AccessDeniedException"
+ },
+ {
+ "target": "com.amazonaws.ecs#ClientException"
+ },
+ {
+ "target": "com.amazonaws.ecs#ClusterNotFoundException"
+ },
+ {
+ "target": "com.amazonaws.ecs#InvalidParameterException"
+ },
+ {
+ "target": "com.amazonaws.ecs#ResourceNotFoundException"
+ },
+ {
+ "target": "com.amazonaws.ecs#ServerException"
+ },
+ {
+ "target": "com.amazonaws.ecs#UnsupportedFeatureException"
+ }
+ ],
+ "traits": {
+ "smithy.api#documentation": "memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)memory
values: 16 GB and 60 GB in 4 GB increments1.4.0
or\n later.memory
values: 32GB and 120 GB in 8 GB increments1.4.0
or\n later.protectionEnabled
to\n\t\t\t\ttrue
to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.protectionEnabled
property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.expiresInMinutes
property. The expiresInMinutes
property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled
set to true
. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.TASK_NOT_VALID
\n\t\t\t\tfailure. For more information, see API\n\t\t\t\t\tfailure reasons.true
to mark a task for protection and false
to\n\t\t\tunset protection, making it eligible for termination.protectionEnabled
to true
, you can specify the\n\t\t\tduration for task protection in minutes. You can specify a value from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in\n\t\t\tevents from Service Auto Scaling or deployments. After this time period lapses,\n\t\t\t\tprotectionEnabled
will be reset to false
.\n
"
+ }
+ },
+ "failures": {
+ "target": "com.amazonaws.ecs#Failures",
+ "traits": {
+ "smithy.api#documentation": "taskArn
: The task ARN.protectionEnabled
: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is enabled for a task, the value is true
. Otherwise, it\n\t\t\t\t\tis false
.expirationDate
: The epoch time when protection for the task will\n\t\t\t\t\texpire.\n AssociatePackage\n
\n operation.\n AuthorizeVpcEndpointAccess
operation.\n Specifies the account to be permitted to manage VPC endpoints against the domain.AuthorizeVpcEndpointAccess
operation.\n Contains the account ID and the type of the account being authorized to access the VPC endpoint.\n CreatePackage\n
\n operation.\n DeleteElasticsearchDomain
operation. Specifies the name of the Elasticsearch domain that you want to delete.CreateVpcEndpointRequest
operation.DeleteElasticsearchDomain
request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.CreateVpcEndpoint
operation. Contains the configuration and status of the VPC Endpoint being created.DeleteElasticsearchDomain
operation. Specifies the name of the Elasticsearch domain that you want to delete.DeleteElasticsearchDomain
request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.\n DeletePackage\n
\n operation.\n DELETING
\n or DELETE_FAILED
).DeleteVpcEndpoint
operation. Contains the summarized detail of the VPC Endpoint being deleted.DescribeReservedElasticsearchInstances
DescribeVpcEndpoints
operation. Specifies the list of VPC endpoints to be described.DescribeVpcEndpoints
operation. Returns a list containing configuration details and\n status of the VPC Endpoints as well as a list containing error responses of the endpoints that could not be described\n DissociatePackage\n
\n operation.\n ListTags
operation. Contains tags for all requested Elasticsearch domains.AuthorizedPrincipal
describing the details of the permissions to manage VPC endpoints against the specified domain.ListVpcEndpointAccess
operation.\n Returns a list of accounts id and account type authorized to manage VPC endpoints.ListVpcEndpointsForDomain
operation. Specifies the domain whose VPC endpoints will be listed.VpcEndpointSummary
summarizing details of the VPC endpoints.ListVpcEndpointsForDomain
operation. Returns a list containing summarized details of the VPC endpoints.ListVpcEndpoints
operation.ListVpcEndpoints
operation. Returns a list containing summarized details of the VPC endpoints.\n
\n
Type of Log File, it can be one of the following:\n
\n Set this value to limit the number of results returned.\n
", "smithy.api#range": { "max": 100 @@ -5114,6 +8009,7 @@ "com.amazonaws.elasticsearchservice#MaximumInstanceCount": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "\n Maximum number of Instances that can be instantiated for given InstanceType.\n
" } }, @@ -5129,6 +8025,7 @@ "com.amazonaws.elasticsearchservice#MinimumInstanceCount": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "\n Minimum number of Instances that can be instantiated for given InstanceType.\n
" } }, @@ -5183,23 +8080,29 @@ } }, "com.amazonaws.elasticsearchservice#OptionState": { - "type": "string", - "traits": { - "smithy.api#documentation": "The state of a requested change. One of the following:
\nThe state of a requested change. One of the following:
\nSpecifies the latest version for the entity.
" } }, @@ -5302,72 +8206,94 @@ } }, "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnectionStatusCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_ACCEPTANCE", - "name": "PENDING_ACCEPTANCE" - }, - { - "value": "VALIDATING", - "name": "VALIDATING" - }, - { - "value": "VALIDATION_FAILED", - "name": "VALIDATION_FAILED" - }, - { - "value": "PROVISIONING", - "name": "PROVISIONING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "REJECTED", - "name": "REJECTED" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "DELETED", - "name": "DELETED" + "type": "enum", + "members": { + "PENDING_ACCEPTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ACCEPTANCE" } - ] - } - }, - "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnections": { - "type": "list", - "member": { - "target": "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnection" - } - }, + }, + "VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATING" + } + }, + "VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED" + } + }, + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnections": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnection" + } + }, "com.amazonaws.elasticsearchservice#OverallChangeStatus": { - "type": "string", - "traits": { - "smithy.api#documentation": "The overall status value of the domain configuration change.
", - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "PROCESSING", - "name": "PROCESSING" - }, - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } + }, + "traits": { + "smithy.api#documentation": "The overall status value of the domain configuration change.
" } }, "com.amazonaws.elasticsearchservice#OwnerId": { @@ -5484,53 +8410,67 @@ } }, "com.amazonaws.elasticsearchservice#PackageStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COPYING", - "name": "COPYING" - }, - { - "value": "COPY_FAILED", - "name": "COPY_FAILED" - }, - { - "value": "VALIDATING", - "name": "VALIDATING" - }, - { - "value": "VALIDATION_FAILED", - "name": "VALIDATION_FAILED" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" + "type": "enum", + "members": { + "COPYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPYING" + } + }, + "COPY_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPY_FAILED" + } + }, + "VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATING" + } + }, + "VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" } - ] + } } }, "com.amazonaws.elasticsearchservice#PackageType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TXT-DICTIONARY", - "name": "TXT_DICTIONARY" + "type": "enum", + "members": { + "TXT_DICTIONARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT-DICTIONARY" } - ] + } } }, "com.amazonaws.elasticsearchservice#PackageVersion": { @@ -5583,6 +8523,26 @@ "smithy.api#documentation": "Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.
" } }, + "com.amazonaws.elasticsearchservice#PrincipalType": { + "type": "enum", + "members": { + "AWS_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_ACCOUNT" + } + }, + "AWS_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SERVICE" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the type of AWS account permitted to manage VPC endpoints.:\n
The number of Elasticsearch instances to reserve.
" } } @@ -5853,6 +8814,7 @@ "Duration": { "target": "com.amazonaws.elasticsearchservice#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The duration, in seconds, for which the Elasticsearch instance is reserved.
" } }, @@ -5877,6 +8839,7 @@ "ElasticsearchInstanceCount": { "target": "com.amazonaws.elasticsearchservice#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The number of Elasticsearch instances that have been reserved.
" } }, @@ -5927,6 +8890,7 @@ "Duration": { "target": "com.amazonaws.elasticsearchservice#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The duration, in seconds, for which the offering will reserve the Elasticsearch instance.
" } }, @@ -5975,22 +8939,26 @@ } }, "com.amazonaws.elasticsearchservice#ReservedElasticsearchInstancePaymentOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALL_UPFRONT", - "name": "ALL_UPFRONT" - }, - { - "value": "PARTIAL_UPFRONT", - "name": "PARTIAL_UPFRONT" - }, - { - "value": "NO_UPFRONT", - "name": "NO_UPFRONT" + "type": "enum", + "members": { + "ALL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_UPFRONT" + } + }, + "PARTIAL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL_UPFRONT" } - ] + }, + "NO_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_UPFRONT" + } + } } }, "com.amazonaws.elasticsearchservice#ResourceAlreadyExistsException": { @@ -6025,6 +8993,70 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.elasticsearchservice#RevokeVpcEndpointAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticsearchservice#RevokeVpcEndpointAccessRequest" + }, + "output": { + "target": "com.amazonaws.elasticsearchservice#RevokeVpcEndpointAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticsearchservice#BaseException" + }, + { + "target": "com.amazonaws.elasticsearchservice#DisabledOperationException" + }, + { + "target": "com.amazonaws.elasticsearchservice#InternalException" + }, + { + "target": "com.amazonaws.elasticsearchservice#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.elasticsearchservice#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Revokes access to an Amazon OpenSearch Service domain that was provided through an interface\n VPC endpoint.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess", + "code": 200 + } + } + }, + "com.amazonaws.elasticsearchservice#RevokeVpcEndpointAccessRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.elasticsearchservice#DomainName", + "traits": { + "smithy.api#documentation": "The name of the OpenSearch Service domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Account": { + "target": "com.amazonaws.elasticsearchservice#AWSAccount", + "traits": { + "smithy.api#documentation": "The account ID to revoke access from.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Revokes access to an Amazon OpenSearch Service domain that was provided through an interface\n VPC endpoint.
" + } + }, + "com.amazonaws.elasticsearchservice#RevokeVpcEndpointAccessResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Container for response parameters to the RevokeVpcEndpointAccess
operation. The response body for this operation is empty.
Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
", - "smithy.api#enum": [ - { - "value": "NO_ROLLBACK", - "name": "NO_ROLLBACK" - }, - { - "value": "DEFAULT_ROLLBACK", - "name": "DEFAULT_ROLLBACK" + "type": "enum", + "members": { + "NO_ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ROLLBACK" } - ] + }, + "DEFAULT_ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT_ROLLBACK" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
" } }, "com.amazonaws.elasticsearchservice#S3BucketName": { @@ -6191,19 +9227,23 @@ } }, "com.amazonaws.elasticsearchservice#ScheduledAutoTuneActionType": { - "type": "string", - "traits": { - "smithy.api#documentation": "Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
", - "smithy.api#enum": [ - { - "value": "JVM_HEAP_SIZE_TUNING", - "name": "JVM_HEAP_SIZE_TUNING" - }, - { - "value": "JVM_YOUNG_GEN_TUNING", - "name": "JVM_YOUNG_GEN_TUNING" + "type": "enum", + "members": { + "JVM_HEAP_SIZE_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JVM_HEAP_SIZE_TUNING" } - ] + }, + "JVM_YOUNG_GEN_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JVM_YOUNG_GEN_TUNING" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
" } }, "com.amazonaws.elasticsearchservice#ScheduledAutoTuneDescription": { @@ -6245,23 +9285,29 @@ } }, "com.amazonaws.elasticsearchservice#ScheduledAutoTuneSeverityType": { - "type": "string", - "traits": { - "smithy.api#documentation": "Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
", - "smithy.api#enum": [ - { - "value": "LOW", - "name": "LOW" - }, - { - "value": "MEDIUM", - "name": "MEDIUM" - }, - { - "value": "HIGH", - "name": "HIGH" + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" } - ] + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
" } }, "com.amazonaws.elasticsearchservice#ServiceSoftwareOptions": { @@ -6502,18 +9548,20 @@ } }, "com.amazonaws.elasticsearchservice#TLSSecurityPolicy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Policy-Min-TLS-1-0-2019-07", - "name": "POLICY_MIN_TLS_1_0_2019_07" - }, - { - "value": "Policy-Min-TLS-1-2-2019-07", - "name": "POLICY_MIN_TLS_1_2_2019_07" + "type": "enum", + "members": { + "POLICY_MIN_TLS_1_0_2019_07": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Policy-Min-TLS-1-0-2019-07" } - ] + }, + "POLICY_MIN_TLS_1_2_2019_07": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Policy-Min-TLS-1-2-2019-07" + } + } } }, "com.amazonaws.elasticsearchservice#Tag": { @@ -6568,23 +9616,29 @@ } }, "com.amazonaws.elasticsearchservice#TimeUnit": { - "type": "string", - "traits": { - "smithy.api#documentation": "Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the Developer Guide for more information.
", - "smithy.api#enum": [ - { - "value": "HOURS", - "name": "HOURS" + "type": "enum", + "members": { + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURS" } - ] + } + }, + "traits": { + "smithy.api#documentation": "Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the Developer Guide for more information.
" } }, "com.amazonaws.elasticsearchservice#TotalNumberOfStages": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.elasticsearchservice#UIntValue": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0 } @@ -6835,6 +9889,80 @@ "com.amazonaws.elasticsearchservice#UpdateTimestamp": { "type": "timestamp" }, + "com.amazonaws.elasticsearchservice#UpdateVpcEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticsearchservice#UpdateVpcEndpointRequest" + }, + "output": { + "target": "com.amazonaws.elasticsearchservice#UpdateVpcEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticsearchservice#BaseException" + }, + { + "target": "com.amazonaws.elasticsearchservice#ConflictException" + }, + { + "target": "com.amazonaws.elasticsearchservice#DisabledOperationException" + }, + { + "target": "com.amazonaws.elasticsearchservice#InternalException" + }, + { + "target": "com.amazonaws.elasticsearchservice#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.elasticsearchservice#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2015-01-01/es/vpcEndpoints/update", + "code": 200 + } + } + }, + "com.amazonaws.elasticsearchservice#UpdateVpcEndpointRequest": { + "type": "structure", + "members": { + "VpcEndpointId": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpointId", + "traits": { + "smithy.api#documentation": "Unique identifier of the VPC endpoint to be updated.
", + "smithy.api#required": {} + } + }, + "VpcOptions": { + "target": "com.amazonaws.elasticsearchservice#VPCOptions", + "traits": { + "smithy.api#documentation": "The security groups and/or subnets to add, remove, or modify.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
" + } + }, + "com.amazonaws.elasticsearchservice#UpdateVpcEndpointResponse": { + "type": "structure", + "members": { + "VpcEndpoint": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint to be updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration and status of the VPC endpoint being updated.
" + } + }, "com.amazonaws.elasticsearchservice#UpgradeElasticsearchDomain": { "type": "operation", "input": { @@ -6967,45 +10095,55 @@ "type": "string" }, "com.amazonaws.elasticsearchservice#UpgradeStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "SUCCEEDED_WITH_ISSUES", - "name": "SUCCEEDED_WITH_ISSUES" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "SUCCEEDED_WITH_ISSUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED_WITH_ISSUES" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.elasticsearchservice#UpgradeStep": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PRE_UPGRADE_CHECK", - "name": "PRE_UPGRADE_CHECK" - }, - { - "value": "SNAPSHOT", - "name": "SNAPSHOT" - }, - { - "value": "UPGRADE", - "name": "UPGRADE" + "type": "enum", + "members": { + "PRE_UPGRADE_CHECK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRE_UPGRADE_CHECK" + } + }, + "SNAPSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPSHOT" + } + }, + "UPGRADE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPGRADE" } - ] + } } }, "com.amazonaws.elasticsearchservice#UpgradeStepItem": { @@ -7167,27 +10305,241 @@ } }, "com.amazonaws.elasticsearchservice#VolumeType": { + "type": "enum", + "members": { + "standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "gp2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gp2" + } + }, + "io1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "io1" + } + }, + "gp3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gp3" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storagefor more information.
" + } + }, + "com.amazonaws.elasticsearchservice#VpcEndpoint": { + "type": "structure", + "members": { + "VpcEndpointId": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpointId", + "traits": { + "smithy.api#documentation": "The unique identifier of the endpoint.
" + } + }, + "VpcEndpointOwner": { + "target": "com.amazonaws.elasticsearchservice#AWSAccount", + "traits": { + "smithy.api#documentation": "The creator of the endpoint.
" + } + }, + "DomainArn": { + "target": "com.amazonaws.elasticsearchservice#DomainArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the domain associated with the endpoint.
" + } + }, + "VpcOptions": { + "target": "com.amazonaws.elasticsearchservice#VPCDerivedInfo", + "traits": { + "smithy.api#documentation": "Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC\n endpoint.
" + } + }, + "Status": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpointStatus", + "traits": { + "smithy.api#documentation": "The current status of the endpoint.
" + } + }, + "Endpoint": { + "target": "com.amazonaws.elasticsearchservice#Endpoint", + "traits": { + "smithy.api#documentation": "The connection endpoint ID for connecting to the domain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The connection endpoint for connecting to an Amazon OpenSearch Service domain through a\n proxy.
" + } + }, + "com.amazonaws.elasticsearchservice#VpcEndpointError": { + "type": "structure", + "members": { + "VpcEndpointId": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpointId", + "traits": { + "smithy.api#documentation": "The unique identifier of the endpoint.
" + } + }, + "ErrorCode": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpointErrorCode", + "traits": { + "smithy.api#documentation": "The code associated with the error.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.elasticsearchservice#String", + "traits": { + "smithy.api#documentation": "A message describing the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Error information when attempting to describe an Amazon OpenSearch Service-managed VPC\n endpoint.
" + } + }, + "com.amazonaws.elasticsearchservice#VpcEndpointErrorCode": { + "type": "enum", + "members": { + "ENDPOINT_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDPOINT_NOT_FOUND" + } + }, + "SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_ERROR" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the error code of the failure encountered while describing the VPC endpoint:\n
The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storagefor more information.
", - "smithy.api#enum": [ - { - "value": "standard", - "name": "standard" - }, - { - "value": "gp2", - "name": "gp2" - }, - { - "value": "io1", - "name": "io1" - }, - { - "value": "gp3", - "name": "gp3" + "smithy.api#length": { + "min": 5, + "max": 256 + }, + "smithy.api#pattern": "^aos-[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.elasticsearchservice#VpcEndpointIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpointId" + } + }, + "com.amazonaws.elasticsearchservice#VpcEndpointStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the current status of the VPC endpoint:\n
The unique identifier of the endpoint.
" + } + }, + "VpcEndpointOwner": { + "target": "com.amazonaws.elasticsearchservice#String", + "traits": { + "smithy.api#documentation": "The creator of the endpoint.
" + } + }, + "DomainArn": { + "target": "com.amazonaws.elasticsearchservice#DomainArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the domain associated with the endpoint.
" + } + }, + "Status": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpointStatus", + "traits": { + "smithy.api#documentation": "The current status of the endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
" + } + }, + "com.amazonaws.elasticsearchservice#VpcEndpointSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpointSummary" + } + }, + "com.amazonaws.elasticsearchservice#VpcEndpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticsearchservice#VpcEndpoint" } }, "com.amazonaws.elasticsearchservice#ZoneAwarenessConfig": { diff --git a/codegen/sdk-codegen/aws-models/resource-explorer-2.json b/codegen/sdk-codegen/aws-models/resource-explorer-2.json index 4d46d231eab..1e36e339d81 100644 --- a/codegen/sdk-codegen/aws-models/resource-explorer-2.json +++ b/codegen/sdk-codegen/aws-models/resource-explorer-2.json @@ -40,7 +40,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the specified view as the default for the Amazon Web Services Region in which you call this\n operation. When a user performs a Search that doesn't explicitly\n specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for\n searches performed in this Amazon Web Services Region.
\nIf an Amazon Web Services Region doesn't have a default view \n configured, then users must explicitly specify a view with every Search
\n operation performed in that Region.
Sets the specified view as the default for the Amazon Web Services Region in which you call this\n operation. When a user performs a Search that doesn't explicitly\n specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for\n searches performed in this Amazon Web Services Region.
\nIf an Amazon Web Services Region doesn't have a default view \n configured, then users must explicitly specify a view with every Search
\n operation performed in that Region.
Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating\n an index. Resource Explorer begins discovering the resources in this Region and stores the details\n about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
\nThis operation creates only a local index. To promote the\n local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the\n UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.
\nFor more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see\n Turn\n on Resource Explorer to index your resources in an Amazon Web Services Region in the\n Amazon Web Services Resource Explorer User Guide.
\nIf this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then\n this operation also creates a\n service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate\n your resources to populate the index.
\n \n \n \n\n Action:\n resource-explorer-2:CreateIndex
\n
\n Resource: The ARN of the index (as it will\n exist after the operation completes) in the Amazon Web Services Region and account in which\n you're trying to create the index. Use the wildcard character (*
)\n at the end of the string to match the eventual UUID. For example, the following\n Resource
element restricts the role or user to creating an\n index in only the us-east-2
Region of the specified account.
\n \"Resource\":\n \"arn:aws:resource-explorer-2:us-east-2:<account-id>:index/*\"
\n
Alternatively, you can use \"Resource\": \"*\"
to allow the role or\n user to create an index in any Region.
\n Action:\n iam:CreateServiceLinkedRole
\n
\n Resource: No specific resource (*).
\nThis permission is required only the first time you create an index to turn on\n Resource Explorer in the account. Resource Explorer uses this to create the service-linked\n role needed to index the resources in your account. Resource Explorer uses the\n same service-linked role for all additional indexes you create\n afterwards.
\nTurns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating\n an index. Resource Explorer begins discovering the resources in this Region and stores the details\n about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
\nThis operation creates only a local index. To promote the\n local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the\n UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.
\nFor more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see\n Turn\n on Resource Explorer to index your resources in an Amazon Web Services Region in the\n Amazon Web Services Resource Explorer User Guide.
\nIf this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then\n this operation also creates a\n service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate\n your resources to populate the index.
\n\n Action:\n resource-explorer-2:CreateIndex
\n
\n Resource: The ARN of the index (as it will\n exist after the operation completes) in the Amazon Web Services Region and account in which\n you're trying to create the index. Use the wildcard character (*
)\n at the end of the string to match the eventual UUID. For example, the following\n Resource
element restricts the role or user to creating an\n index in only the us-east-2
Region of the specified account.
\n \"Resource\":\n \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"
\n
Alternatively, you can use \"Resource\": \"*\"
to allow the role or\n user to create an index in any Region.
\n Action:\n iam:CreateServiceLinkedRole
\n
\n Resource: No specific resource (*).
\nThis permission is required only the first time you create an index to turn on\n Resource Explorer in the account. Resource Explorer uses this to create the service-linked\n role needed to index the resources in your account. Resource Explorer uses the\n same service-linked role for all additional indexes you create\n afterwards.
\nIndicates the current state of the index. You can check for changes to the state for\n asynchronous operations by calling the GetIndex operation.
\nThe state can remain in the CREATING
or UPDATING
state\n for several hours as Resource Explorer discovers the information about your resources and\n populates the index.
Indicates the current state of the index. You can check for changes to the state for\n asynchronous operations by calling the GetIndex operation.
\nThe state can remain in the CREATING
or UPDATING
state\n for several hours as Resource Explorer discovers the information about your resources and\n populates the index.
Creates a view that users can query by using the Search operation.\n Results from queries that you make using this view include only resources that match the\n view's Filters
. For more information about Amazon Web Services Resource Explorer views, see Managing views\n in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow
\n to the Search
action on a Resource
with the Amazon resource name (ARN) of\n this view can Search using views you create with this\n operation.
Creates a view that users can query by using the Search operation.\n Results from queries that you make using this view include only resources that match the\n view's Filters
. For more information about Amazon Web Services Resource Explorer views, see Managing views\n in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow
\n to the Search
action on a Resource
with the Amazon resource name (ARN) of\n this view can Search using views you create with this\n operation.
The name of the new view. This name appears in the list of views in Resource Explorer.
\nThe name must be no more than 64 characters long, and can include letters, digits, and\n the dash (-) character. The name must be unique within its Amazon Web Services Region.
", + "smithy.api#documentation": "The name of the new view. This name appears in the list of views in Resource Explorer.
\nThe name must be no more than 64 characters long, and can include letters, digits, and\n the dash (-) character. The name must be unique within its Amazon Web Services Region.
", "smithy.api#required": {} } }, @@ -382,7 +382,7 @@ "Filters": { "target": "com.amazonaws.resourceexplorer2#SearchFilter", "traits": { - "smithy.api#documentation": "An array of strings that specify which resources are included in the results of \n queries made using this view. When you use this view in a Search \n operation, the filter string is combined with the search's QueryString
\n parameter using a logical AND
operator.
For information about the supported syntax, see Search query reference for\n Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
\nThis query string in the context of this operation supports only filter\n prefixes with optional operators. It doesn't support free-form text. For example, the \n string region:us* service:ec2 -tag:stage=prod
includes all Amazon EC2 \n resources in any Amazon Web Services Region that begins with the letters us
and is\n not tagged with a key Stage
that has the value\n prod
.
An array of strings that specify which resources are included in the results of \n queries made using this view. When you use this view in a Search \n operation, the filter string is combined with the search's QueryString
\n parameter using a logical AND
operator.
For information about the supported syntax, see Search query reference for\n Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
\nThis query string in the context of this operation supports only filter\n prefixes with optional operators. It doesn't support free-form text. For example, the \n string region:us* service:ec2 -tag:stage=prod
includes all Amazon EC2 \n resources in any Amazon Web Services Region that begins with the letters us
and is\n not tagged with a key Stage
that has the value\n prod
.
The Amazon resource name (ARN) of the index that you successfully started the deletion\n process.
\nThis operation is asynchronous. To check its status, call the GetIndex operation.
\nThe Amazon resource name (ARN) of the index that you successfully started the deletion\n process.
\nThis operation is asynchronous. To check its status, call the GetIndex operation.
\nDeletes the specified view.
\nIf the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use\n until you configure a new default by calling the AssociateDefaultView\n operation.
", + "smithy.api#documentation": "Deletes the specified view.
\nIf the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use\n until you configure a new default by calling the AssociateDefaultView\n operation.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteView" @@ -576,7 +576,7 @@ } ], "traits": { - "smithy.api#documentation": "After you call this operation, the affected Amazon Web Services Region no longer has a default view.\n All Search operations in that Region must explicitly specify a view or\n the operation fails. You can configure a new default by calling the AssociateDefaultView operation.
\nIf an Amazon Web Services Region doesn't have a default view \n configured, then users must explicitly specify a view with every Search
\n operation performed in that Region.
After you call this operation, the affected Amazon Web Services Region no longer has a default view.\n All Search operations in that Region must explicitly specify a view or\n the operation fails. You can configure a new default by calling the AssociateDefaultView operation.
\nIf an Amazon Web Services Region doesn't have a default view \n configured, then users must explicitly specify a view with every Search
\n operation performed in that Region.
The name of the property that is included in this view.
\nYou can specify the following property names for this field:
\n\n Tags
\n
The name of the property that is included in this view.
\nYou can specify the following property names for this field:
\n\n Tags
\n
The type of index. It can be one of the following\n values:
\n\n LOCAL – The index contains information\n about resources from only the same Amazon Web Services Region.
\n\n AGGREGATOR – Resource Explorer replicates copies\n of the indexed information about resources in all other Amazon Web Services Regions to the\n aggregator index. This lets search results in the Region with the aggregator index to\n include resources from all Regions in the account where Resource Explorer is turned\n on.
\nThe type of index. It can be one of the following\n values:
\n\n LOCAL – The index contains information\n about resources from only the same Amazon Web Services Region.
\n\n AGGREGATOR – Resource Explorer replicates copies\n of the indexed information about resources in all other Amazon Web Services Regions to the\n aggregator index. This lets search results in the Region with the aggregator index to\n include resources from all Regions in the account where Resource Explorer is turned\n on.
\nAn index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services\n resources that the service discovers. Creating an index in an Amazon Web Services Region turns on\n Resource Explorer and lets it discover your resources.
\nBy default, an index is local, meaning that it contains\n information about resources in only the same Region as the index. However, you can\n promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index\n receives a replicated copy of the index information from all other Regions where Resource Explorer\n is turned on. This allows search operations in that Region to return results from all\n Regions in the account.
" + "smithy.api#documentation": "An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services\n resources that the service discovers. Creating an index in an Amazon Web Services Region turns on\n Resource Explorer and lets it discover your resources.
\nBy default, an index is local, meaning that it contains\n information about resources in only the same Region as the index. However, you can\n promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index\n receives a replicated copy of the index information from all other Regions where Resource Explorer\n is turned on. This allows search operations in that Region to return results from all\n Regions in the account.
" } }, "com.amazonaws.resourceexplorer2#IndexList": { @@ -950,7 +950,7 @@ "Type": { "target": "com.amazonaws.resourceexplorer2#IndexType", "traits": { - "smithy.api#documentation": "If specified, limits the output to only indexes of the specified Type, either\n LOCAL
or AGGREGATOR
.
Use this option to discover the aggregator index for your account.
" + "smithy.api#documentation": "If specified, limits the output to only indexes of the specified Type, either\n LOCAL
or AGGREGATOR
.
Use this option to discover the aggregator index for your account.
" } }, "Regions": { @@ -1161,7 +1161,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you\n call this operation.
\nAlways check the NextToken
response parameter \nfor a null
value when calling a paginated operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken
response parameter value is null
\n only \nwhen there are no more results to display.
Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you\n call this operation.
\nAlways check the NextToken
response parameter \nfor a null
value when calling a paginated operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken
response parameter value is null
\n only \nwhen there are no more results to display.
Indicates whether the TotalResources
value represents an exhaustive count\n of search results.
If True
, it indicates that the search was exhaustive. Every\n resource that matches the query was counted.
If False
, then the search reached the limit of\n 1,000 matching results, and stopped counting.
Indicates whether the TotalResources
value represents an exhaustive count\n of search results.
If True
, it indicates that the search was exhaustive. Every\n resource that matches the query was counted.
If False
, then the search reached the limit of\n 1,000 matching results, and stopped counting.
Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer\n doesn't count more than 1,000 matches for any query. This structure\n provides information about whether the query exceeded this limit.
\nThis field is included in every page when you paginate the results.
" + "smithy.api#documentation": "Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer\n doesn't count more than 1,000 matches for any query. This structure\n provides information about whether the query exceeded this limit.
\nThis field is included in every page when you paginate the results.
" } }, "com.amazonaws.resourceexplorer2#ResourceExplorer": { @@ -1364,7 +1364,7 @@ "x-amz-source-account" ] }, - "smithy.api#documentation": "Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can\n explore your resources using an internet search engine-like experience. Examples of\n resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB\n tables. You can search for your resources using resource metadata like names, tags, and\n IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn\n the service on, to simplify your cross-Region workloads.
\nResource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which\n you turn on Resource Explorer. Resource Explorer creates and\n maintains an index in each Region, with the details of that Region's\n resources.
\nYou can search across all of the indexed\n Regions in your account by designating one of your Amazon Web Services Regions to contain\n the aggregator index for the account. When you promote a local index in\n a Region to become the aggregator index for the account, Resource Explorer automatically\n replicates the index information from all local indexes in the other Regions to the\n aggregator index. Therefore, the Region with the aggregator index has a copy of all resource\n information for all Regions in the account where you turned on Resource Explorer. As a result,\n views in the aggregator index Region include resources from all of the indexed Regions in your\n account.
\n \nFor more information about Amazon Web Services Resource Explorer, including how to enable and configure the\n service, see the Amazon Web Services Resource Explorer User Guide.
\nThe example HTTP query requests and responses in this guide are displayed with the\n JSON formatted across multiple lines for\n readability. The actual query responses from the Resource Explorer service do not include this\n extra whitespace.
\n\n We want your feedback about this documentation\n
\nOur goal is to help you get everything you can from Resource Explorer. If this guide helps you to\n do that, then let us know. If the guide isn't helping you, then we want to hear from you\n so we can address the issue. Use the Feedback link\n that's in the upper-right corner of every page. That sends your comments directly to the\n writers of this guide. We review every submission, looking for opportunities to improve\n the documentation. Thank you in advance for your help!
", + "smithy.api#documentation": "Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can\n explore your resources using an internet search engine-like experience. Examples of\n resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB\n tables. You can search for your resources using resource metadata like names, tags, and\n IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn\n the service on, to simplify your cross-Region workloads.
\nResource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which\n you turn on Resource Explorer. Resource Explorer creates and\n maintains an index in each Region, with the details of that Region's\n resources.
\nYou can search across all of the indexed\n Regions in your account by designating one of your Amazon Web Services Regions to contain\n the aggregator index for the account. When you promote a local index in\n a Region to become the aggregator index for the account, Resource Explorer automatically\n replicates the index information from all local indexes in the other Regions to the\n aggregator index. Therefore, the Region with the aggregator index has a copy of all resource\n information for all Regions in the account where you turned on Resource Explorer. As a result,\n views in the aggregator index Region include resources from all of the indexed Regions in your\n account.
\nFor more information about Amazon Web Services Resource Explorer, including how to enable and configure the\n service, see the Amazon Web Services Resource Explorer User Guide.
", "smithy.api#title": "AWS Resource Explorer", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -2878,7 +2878,7 @@ } ], "traits": { - "smithy.api#documentation": "Searches for resources and displays details about all resources that match the\n specified criteria. You must specify a query string.
\nAll search queries must use a view. If you don't explicitly specify a view, then\n Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.\n The results are the logical intersection of the results that match both the\n QueryString
parameter supplied to this operation and the\n SearchFilter
parameter attached to the view.
For the complete syntax supported by the QueryString
parameter, see\n Search\n query syntax reference for Resource Explorer.
If your search results are empty, or are missing results that you think should be\n there, see Troubleshooting Resource Explorer\n search.
", + "smithy.api#documentation": "Searches for resources and displays details about all resources that match the\n specified criteria. You must specify a query string.
\nAll search queries must use a view. If you don't explicitly specify a view, then\n Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.\n The results are the logical intersection of the results that match both the\n QueryString
parameter supplied to this operation and the\n SearchFilter
parameter attached to the view.
For the complete syntax supported by the QueryString
parameter, see\n Search\n query syntax reference for Resource Explorer.
If your search results are empty, or are missing results that you think should be\n there, see Troubleshooting Resource Explorer\n search.
", "smithy.api#http": { "method": "POST", "uri": "/Search" @@ -2918,7 +2918,7 @@ "QueryString": { "target": "com.amazonaws.resourceexplorer2#QueryString", "traits": { - "smithy.api#documentation": "A string that includes keywords and filters that specify the resources that you want\n to include in the results.
\nFor the complete syntax supported by the QueryString
parameter, see\n Search query syntax reference for Resource Explorer.
The search is completely case insensitive. You can specify an empty string to return\n all results up to the limit of 1,000 total results.
\nThe operation can return only the first 1,000 results. If the\n resource you want is not included, then use a different value for\n QueryString
to refine the results.
A string that includes keywords and filters that specify the resources that you want\n to include in the results.
\nFor the complete syntax supported by the QueryString
parameter, see\n Search query syntax reference for Resource Explorer.
The search is completely case insensitive. You can specify an empty string to return\n all results up to the limit of 1,000 total results.
\nThe operation can return only the first 1,000 results. If the\n resource you want is not included, then use a different value for\n QueryString
to refine the results.
Changes the type of the index from one of the following types to the other. For more\n information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on\n cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.
\n\n \n AGGREGATOR
index type\n
The index contains information about resources from all Amazon Web Services Regions in the\n Amazon Web Services account in which you've created a Resource Explorer index. Resource information from\n all other Regions is replicated to this Region's index.
\nWhen you change the index type to AGGREGATOR
, Resource Explorer turns on\n replication of all discovered resource information from the other Amazon Web Services Regions\n in your account to this index. You can then, from this Region only, perform\n resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account.\n Turning on replication from all other Regions is performed by asynchronous\n background tasks. You can check the status of the asynchronous tasks by using\n the GetIndex operation. When the asynchronous tasks complete,\n the Status
response of that operation changes from\n UPDATING
to ACTIVE
. After that, you can start to\n see results from other Amazon Web Services Regions in query results. However, it can take\n several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can\n promote a different index to be the aggregator index for the account, you must\n first demote the existing aggregator index to type LOCAL
.
\n \n LOCAL
index type\n
The index contains information about resources in only the Amazon Web Services Region in\n which the index exists. If an aggregator index in another Region exists, then\n information in this local index is replicated to the aggregator index.
\nWhen you change the index type to LOCAL
, Resource Explorer turns off the\n replication of resource information from all other Amazon Web Services Regions in the\n Amazon Web Services account to this Region. The aggregator index remains in the\n UPDATING
state until all replication with other Regions\n successfully stops. You can check the status of the asynchronous task by using\n the GetIndex operation. When Resource Explorer successfully stops all\n replication with other Regions, the Status
response of that\n operation changes from UPDATING
to ACTIVE
. Separately,\n the resource information from other Regions that was previously stored in the\n index is deleted within 30 days by another background task. Until that\n asynchronous task completes, some results from other Regions can continue to\n appear in search results.
After you demote an aggregator index to a local index, you must wait\n 24 hours before you can promote another index to be the new\n aggregator index for the account.
\nChanges the type of the index from one of the following types to the other. For more\n information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on\n cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.
\n\n \n AGGREGATOR
index type\n
The index contains information about resources from all Amazon Web Services Regions in the\n Amazon Web Services account in which you've created a Resource Explorer index. Resource information from\n all other Regions is replicated to this Region's index.
\nWhen you change the index type to AGGREGATOR
, Resource Explorer turns on\n replication of all discovered resource information from the other Amazon Web Services Regions\n in your account to this index. You can then, from this Region only, perform\n resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account.\n Turning on replication from all other Regions is performed by asynchronous\n background tasks. You can check the status of the asynchronous tasks by using\n the GetIndex operation. When the asynchronous tasks complete,\n the Status
response of that operation changes from\n UPDATING
to ACTIVE
. After that, you can start to\n see results from other Amazon Web Services Regions in query results. However, it can take\n several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can\n promote a different index to be the aggregator index for the account, you must\n first demote the existing aggregator index to type LOCAL
.
\n \n LOCAL
index type\n
The index contains information about resources in only the Amazon Web Services Region in\n which the index exists. If an aggregator index in another Region exists, then\n information in this local index is replicated to the aggregator index.
\nWhen you change the index type to LOCAL
, Resource Explorer turns off the\n replication of resource information from all other Amazon Web Services Regions in the\n Amazon Web Services account to this Region. The aggregator index remains in the\n UPDATING
state until all replication with other Regions\n successfully stops. You can check the status of the asynchronous task by using\n the GetIndex operation. When Resource Explorer successfully stops all\n replication with other Regions, the Status
response of that\n operation changes from UPDATING
to ACTIVE
. Separately,\n the resource information from other Regions that was previously stored in the\n index is deleted within 30 days by another background task. Until that\n asynchronous task completes, some results from other Regions can continue to\n appear in search results.
After you demote an aggregator index to a local index, you must wait\n 24 hours before you can promote another index to be the new\n aggregator index for the account.
\nAn array of strings that specify which resources are included in the results of \n queries made using this view. When you use this view in a Search \n operation, the filter string is combined with the search's QueryString
\n parameter using a logical AND
operator.
For information about the supported syntax, see Search query reference for\n Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
\nThis query string in the context of this operation supports only filter\n prefixes with optional operators. It doesn't support free-form text. For example, the \n string region:us* service:ec2 -tag:stage=prod
includes all Amazon EC2 \n resources in any Amazon Web Services Region that begins with the letters us
and is\n not tagged with a key Stage
that has the value\n prod
.
An array of strings that specify which resources are included in the results of \n queries made using this view. When you use this view in a Search \n operation, the filter string is combined with the search's QueryString
\n parameter using a logical AND
operator.
For information about the supported syntax, see Search query reference for\n Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
\nThis query string in the context of this operation supports only filter\n prefixes with optional operators. It doesn't support free-form text. For example, the \n string region:us* service:ec2 -tag:stage=prod
includes all Amazon EC2 \n resources in any Amazon Web Services Region that begins with the letters us
and is\n not tagged with a key Stage
that has the value\n prod
.
\n Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service.\n EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets.\n The following reference lists the available API actions, and data types for EventBridge Scheduler.\n
", + "smithy.api#title": "Amazon EventBridge Scheduler", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://scheduler-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://scheduler-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://scheduler.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://scheduler.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scheduler-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scheduler.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scheduler-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scheduler.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scheduler-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scheduler.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scheduler.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.scheduler#AssignPublicIp": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.scheduler#AwsVpcConfiguration": { + "type": "structure", + "members": { + "Subnets": { + "target": "com.amazonaws.scheduler#Subnets", + "traits": { + "smithy.api#documentation": "Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
", + "smithy.api#required": {} + } + }, + "SecurityGroups": { + "target": "com.amazonaws.scheduler#SecurityGroups", + "traits": { + "smithy.api#documentation": "Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups.\n If you do not specify a security group, the default security group for the VPC is used.
" + } + }, + "AssignPublicIp": { + "target": "com.amazonaws.scheduler#AssignPublicIp", + "traits": { + "smithy.api#documentation": "Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED
only when LaunchType
in EcsParameters
is set to FARGATE
.
This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
" + } + }, + "com.amazonaws.scheduler#CapacityProvider": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.scheduler#CapacityProviderStrategy": { + "type": "list", + "member": { + "target": "com.amazonaws.scheduler#CapacityProviderStrategyItem" + }, + "traits": { + "smithy.api#length": { + "max": 6 + } + } + }, + "com.amazonaws.scheduler#CapacityProviderStrategyItem": { + "type": "structure", + "members": { + "capacityProvider": { + "target": "com.amazonaws.scheduler#CapacityProvider", + "traits": { + "smithy.api#documentation": "The short name of the capacity provider.
", + "smithy.api#required": {} + } + }, + "weight": { + "target": "com.amazonaws.scheduler#CapacityProviderStrategyItemWeight", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the\n base value, if defined, is satisfied.
" + } + }, + "base": { + "target": "com.amazonaws.scheduler#CapacityProviderStrategyItemBase", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.\n If no value is specified, the default value of 0
is used.
The details of a capacity provider strategy.
" + } + }, + "com.amazonaws.scheduler#CapacityProviderStrategyItemBase": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.scheduler#CapacityProviderStrategyItemWeight": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.scheduler#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.scheduler#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Updating or deleting the resource can cause an inconsistent state.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.scheduler#CreateSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#CreateScheduleInput" + }, + "output": { + "target": "com.amazonaws.scheduler#CreateScheduleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#ConflictException" + }, + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates the specified schedule.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/schedules/{Name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.scheduler#CreateScheduleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#CreateScheduleGroupInput" + }, + "output": { + "target": "com.amazonaws.scheduler#CreateScheduleGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#ConflictException" + }, + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates the specified schedule group.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/schedule-groups/{Name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.scheduler#CreateScheduleGroupInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group that you are creating.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.scheduler#TagList", + "traits": { + "smithy.api#documentation": "The list of tags to associate with the schedule group.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.scheduler#ClientToken", + "traits": { + "smithy.api#documentation": "\n Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,\n EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. \n
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.scheduler#CreateScheduleGroupOutput": { + "type": "structure", + "members": { + "ScheduleGroupArn": { + "target": "com.amazonaws.scheduler#ScheduleGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule group.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.scheduler#CreateScheduleInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.scheduler#Name", + "traits": { + "smithy.api#documentation": "The name of the schedule that you are creating.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
" + } + }, + "ScheduleExpression": { + "target": "com.amazonaws.scheduler#ScheduleExpression", + "traits": { + "smithy.api#documentation": "\n The expression that defines when the schedule runs. The following formats are supported.\n
\n\n at
expression - at(yyyy-mm-ddThh:mm:ss)
\n
\n rate
expression - rate(unit value)
\n
\n cron
expression - cron(fields)
\n
\n You can use at
expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate
and cron
expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n
\n A cron
expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year)
.\n
\n A rate
expression consists of a value as a positive integer, and a unit with the following options:\n minute
| minutes
| hour
| hours
| day
| days
\n
\n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n
", + "smithy.api#required": {} + } + }, + "StartDate": { + "target": "com.amazonaws.scheduler#StartDate", + "traits": { + "smithy.api#documentation": "The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate
you specify.\nEventBridge Scheduler ignores StartDate
for one-time schedules.
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate
you specify.\nEventBridge Scheduler ignores EndDate
for one-time schedules.
The description you specify for the schedule.
" + } + }, + "ScheduleExpressionTimezone": { + "target": "com.amazonaws.scheduler#ScheduleExpressionTimezone", + "traits": { + "smithy.api#documentation": "The timezone in which the scheduling expression is evaluated.
" + } + }, + "State": { + "target": "com.amazonaws.scheduler#ScheduleState", + "traits": { + "smithy.api#documentation": "Specifies whether the schedule is enabled or disabled.
" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.scheduler#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
" + } + }, + "Target": { + "target": "com.amazonaws.scheduler#Target", + "traits": { + "smithy.api#documentation": "The schedule's target.
", + "smithy.api#required": {} + } + }, + "FlexibleTimeWindow": { + "target": "com.amazonaws.scheduler#FlexibleTimeWindow", + "traits": { + "smithy.api#documentation": "Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.scheduler#ClientToken", + "traits": { + "smithy.api#documentation": "\n Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,\n EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. \n
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.scheduler#CreateScheduleOutput": { + "type": "structure", + "members": { + "ScheduleArn": { + "target": "com.amazonaws.scheduler#ScheduleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.scheduler#CreationDate": { + "type": "timestamp" + }, + "com.amazonaws.scheduler#DeadLetterConfig": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.scheduler#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.
", + "smithy.api#pattern": "^arn:aws(-[a-z]+)?:sqs:[a-z0-9\\-]+:\\d{12}:[a-zA-Z0-9\\-_]+$" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
" + } + }, + "com.amazonaws.scheduler#DeleteSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#DeleteScheduleInput" + }, + "output": { + "target": "com.amazonaws.scheduler#DeleteScheduleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#ConflictException" + }, + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified schedule.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/schedules/{Name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.scheduler#DeleteScheduleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#DeleteScheduleGroupInput" + }, + "output": { + "target": "com.amazonaws.scheduler#DeleteScheduleGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#ConflictException" + }, + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group.\n When you delete a group, it remains in a DELETING
state until all of its associated schedules are deleted.\n Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets\n until the schedule group and its associated schedules are deleted.
\n This operation is eventually consistent.\n
\nThe name of the schedule group to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Name" + } + }, + "ClientToken": { + "target": "com.amazonaws.scheduler#ClientToken", + "traits": { + "smithy.api#documentation": "\n Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,\n EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. \n
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.scheduler#DeleteScheduleGroupOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.scheduler#DeleteScheduleInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.scheduler#Name", + "traits": { + "smithy.api#documentation": "The name of the schedule to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.
", + "smithy.api#httpQuery": "groupName" + } + }, + "ClientToken": { + "target": "com.amazonaws.scheduler#ClientToken", + "traits": { + "smithy.api#documentation": "\n Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,\n EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. \n
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.scheduler#DeleteScheduleOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.scheduler#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.scheduler#DetailType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.scheduler#EcsParameters": { + "type": "structure", + "members": { + "TaskDefinitionArn": { + "target": "com.amazonaws.scheduler#TaskDefinitionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
", + "smithy.api#required": {} + } + }, + "TaskCount": { + "target": "com.amazonaws.scheduler#TaskCount", + "traits": { + "smithy.api#documentation": "The number of tasks to create based on TaskDefinition
. The default is 1
.
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task.\n The FARGATE
value is supported only in the Regions where Fargate with Amazon ECS is supported.\n For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide.
This structure specifies the network configuration for an ECS task.
" + } + }, + "PlatformVersion": { + "target": "com.amazonaws.scheduler#PlatformVersion", + "traits": { + "smithy.api#documentation": "Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0
.
Specifies an ECS task group for the task. The maximum length is 255 characters.
" + } + }, + "CapacityProviderStrategy": { + "target": "com.amazonaws.scheduler#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "The capacity provider strategy to use for the task.
" + } + }, + "EnableECSManagedTags": { + "target": "com.amazonaws.scheduler#EnableECSManagedTags", + "traits": { + "smithy.api#documentation": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources\n in the Amazon ECS Developer Guide.
" + } + }, + "EnableExecuteCommand": { + "target": "com.amazonaws.scheduler#EnableExecuteCommand", + "traits": { + "smithy.api#documentation": "Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
" + } + }, + "PlacementConstraints": { + "target": "com.amazonaws.scheduler#PlacementConstraints", + "traits": { + "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
" + } + }, + "PlacementStrategy": { + "target": "com.amazonaws.scheduler#PlacementStrategies", + "traits": { + "smithy.api#documentation": "The task placement strategy for a task or service.
" + } + }, + "PropagateTags": { + "target": "com.amazonaws.scheduler#PropagateTags", + "traits": { + "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated.\n Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's \n TagResource
\n \n API action.\n
The reference ID to use for the task.
" + } + }, + "Tags": { + "target": "com.amazonaws.scheduler#Tags", + "traits": { + "smithy.api#documentation": "The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.\n For more information, see \n RunTask
\n in the Amazon ECS API Reference.
The templated target type for the Amazon ECS \n RunTask
\n API operation.
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.scheduler#Source", + "traits": { + "smithy.api#documentation": "The source of the event.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The templated target type for the EventBridge \n PutEvents
\n API operation.
Determines whether the schedule is invoked within a flexible time window.
", + "smithy.api#required": {} + } + }, + "MaximumWindowInMinutes": { + "target": "com.amazonaws.scheduler#MaximumWindowInMinutes", + "traits": { + "smithy.api#documentation": "The maximum time window during which a schedule can be invoked.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
" + } + }, + "com.amazonaws.scheduler#FlexibleTimeWindowMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OFF", + "name": "OFF" + }, + { + "value": "FLEXIBLE", + "name": "FLEXIBLE" + } + ] + } + }, + "com.amazonaws.scheduler#GetSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#GetScheduleInput" + }, + "output": { + "target": "com.amazonaws.scheduler#GetScheduleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified schedule.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/schedules/{Name}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.scheduler#GetScheduleGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#GetScheduleGroupInput" + }, + "output": { + "target": "com.amazonaws.scheduler#GetScheduleGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the specified schedule group.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/schedule-groups/{Name}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.scheduler#GetScheduleGroupInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.scheduler#GetScheduleGroupOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.scheduler#ScheduleGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule group.
" + } + }, + "Name": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group.
" + } + }, + "State": { + "target": "com.amazonaws.scheduler#ScheduleGroupState", + "traits": { + "smithy.api#documentation": "Specifies the state of the schedule group.
" + } + }, + "CreationDate": { + "target": "com.amazonaws.scheduler#CreationDate", + "traits": { + "smithy.api#documentation": "The time at which the schedule group was created.
" + } + }, + "LastModificationDate": { + "target": "com.amazonaws.scheduler#LastModificationDate", + "traits": { + "smithy.api#documentation": "The time at which the schedule group was last modified.
" + } + } + } + }, + "com.amazonaws.scheduler#GetScheduleInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.scheduler#Name", + "traits": { + "smithy.api#documentation": "The name of the schedule to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.
", + "smithy.api#httpQuery": "groupName" + } + } + } + }, + "com.amazonaws.scheduler#GetScheduleOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.scheduler#ScheduleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule.
" + } + }, + "GroupName": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group associated with this schedule.
" + } + }, + "Name": { + "target": "com.amazonaws.scheduler#Name", + "traits": { + "smithy.api#documentation": "The name of the schedule.
" + } + }, + "ScheduleExpression": { + "target": "com.amazonaws.scheduler#ScheduleExpression", + "traits": { + "smithy.api#documentation": "\n The expression that defines when the schedule runs. The following formats are supported.\n
\n\n at
expression - at(yyyy-mm-ddThh:mm:ss)
\n
\n rate
expression - rate(unit value)
\n
\n cron
expression - cron(fields)
\n
\n You can use at
expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate
and cron
expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n
\n A cron
expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year)
.\n
\n A rate
expression consists of a value as a positive integer, and a unit with the following options:\n minute
| minutes
| hour
| hours
| day
| days
\n
\n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n
" + } + }, + "StartDate": { + "target": "com.amazonaws.scheduler#StartDate", + "traits": { + "smithy.api#documentation": "The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate
you specify.\nEventBridge Scheduler ignores StartDate
for one-time schedules.
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate
you specify.\nEventBridge Scheduler ignores EndDate
for one-time schedules.
The description of the schedule.
" + } + }, + "ScheduleExpressionTimezone": { + "target": "com.amazonaws.scheduler#ScheduleExpressionTimezone", + "traits": { + "smithy.api#documentation": "The timezone in which the scheduling expression is evaluated.
" + } + }, + "State": { + "target": "com.amazonaws.scheduler#ScheduleState", + "traits": { + "smithy.api#documentation": "Specifies whether the schedule is enabled or disabled.
" + } + }, + "CreationDate": { + "target": "com.amazonaws.scheduler#CreationDate", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The time at which the schedule was created.
", + "smithy.api#suppress": [ + "UnstableTrait" + ] + } + }, + "LastModificationDate": { + "target": "com.amazonaws.scheduler#LastModificationDate", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The time at which the schedule was last modified.
", + "smithy.api#suppress": [ + "UnstableTrait" + ] + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.scheduler#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
" + } + }, + "Target": { + "target": "com.amazonaws.scheduler#Target", + "traits": { + "smithy.api#documentation": "The schedule target.
" + } + }, + "FlexibleTimeWindow": { + "target": "com.amazonaws.scheduler#FlexibleTimeWindow", + "traits": { + "smithy.api#documentation": "Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
" + } + } + } + }, + "com.amazonaws.scheduler#Group": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.scheduler#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Unexpected error encountered while processing the request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.scheduler#KinesisParameters": { + "type": "structure", + "members": { + "PartitionKey": { + "target": "com.amazonaws.scheduler#TargetPartitionKey", + "traits": { + "smithy.api#documentation": "Specifies the shard to which EventBridge Scheduler sends the event. For more information, see Amazon Kinesis Data Streams terminology and concepts in the\n Amazon Kinesis Streams Developer Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The templated target type for the Amazon Kinesis \n PutRecord
\n API operation.
Returns a paginated list of your schedule groups.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/schedule-groups" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "ScheduleGroups" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.scheduler#ListScheduleGroupsInput": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.scheduler#ScheduleGroupNamePrefix", + "traits": { + "smithy.api#documentation": "The name prefix that you can use to return a filtered list of your schedule groups.
", + "smithy.api#httpQuery": "NamePrefix" + } + }, + "NextToken": { + "target": "com.amazonaws.scheduler#NextToken", + "traits": { + "smithy.api#documentation": "The token returned by a previous call to retrieve the next set of results.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.scheduler#MaxResults", + "traits": { + "smithy.api#documentation": "If specified, limits the number of results returned by this operation. The operation also returns a NextToken
which you can use in a subsequent operation to retrieve the next set of results.
Indicates whether there are additional results to retrieve. If the value is null, there are no more results.
" + } + }, + "ScheduleGroups": { + "target": "com.amazonaws.scheduler#ScheduleGroupList", + "traits": { + "smithy.api#documentation": "The schedule groups that match the specified criteria.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.scheduler#ListSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#ListSchedulesInput" + }, + "output": { + "target": "com.amazonaws.scheduler#ListSchedulesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of your EventBridge Scheduler schedules.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/schedules" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Schedules" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.scheduler#ListSchedulesInput": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "If specified, only lists the schedules whose associated schedule group matches the given filter.
", + "smithy.api#httpQuery": "ScheduleGroup" + } + }, + "NamePrefix": { + "target": "com.amazonaws.scheduler#NamePrefix", + "traits": { + "smithy.api#documentation": "Schedule name prefix to return the filtered list of resources.
", + "smithy.api#httpQuery": "NamePrefix" + } + }, + "State": { + "target": "com.amazonaws.scheduler#ScheduleState", + "traits": { + "smithy.api#documentation": "If specified, only lists the schedules whose current state matches the given filter.
", + "smithy.api#httpQuery": "State" + } + }, + "NextToken": { + "target": "com.amazonaws.scheduler#NextToken", + "traits": { + "smithy.api#documentation": "The token returned by a previous call to retrieve the next set of results.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.scheduler#MaxResults", + "traits": { + "smithy.api#documentation": "If specified, limits the number of results returned by this operation. The operation also returns a NextToken
which you can use in a subsequent operation to retrieve the next set of results.
Indicates whether there are additional results to retrieve. If the value is null, there are no more results.
" + } + }, + "Schedules": { + "target": "com.amazonaws.scheduler#ScheduleList", + "traits": { + "smithy.api#documentation": "The schedules that match the specified criteria.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.scheduler#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.scheduler#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags associated with the Scheduler resource.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.scheduler#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.scheduler#TagResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the EventBridge Scheduler resource for which you want to view tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.scheduler#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.scheduler#TagList", + "traits": { + "smithy.api#documentation": "The list of tags associated with the specified resource.
" + } + } + } + }, + "com.amazonaws.scheduler#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.scheduler#MaximumEventAgeInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 86400 + } + } + }, + "com.amazonaws.scheduler#MaximumRetryAttempts": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 185 + } + } + }, + "com.amazonaws.scheduler#MaximumWindowInMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1440 + } + } + }, + "com.amazonaws.scheduler#MessageGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.scheduler#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$" + } + }, + "com.amazonaws.scheduler#NamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z][0-9a-zA-Z-_]*$" + } + }, + "com.amazonaws.scheduler#NetworkConfiguration": { + "type": "structure", + "members": { + "awsvpcConfiguration": { + "target": "com.amazonaws.scheduler#AwsVpcConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the network configuration for an ECS task.
" + } + }, + "com.amazonaws.scheduler#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.scheduler#PlacementConstraint": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.scheduler#PlacementConstraintType", + "traits": { + "smithy.api#documentation": "The type of constraint. Use distinctInstance
to ensure that each task in a particular group is running on a different container instance. Use memberOf
to restrict the selection to a group of valid candidates.
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance
.\n For more information, see Cluster query language in the Amazon ECS Developer Guide.
An object representing a constraint on task placement.
" + } + }, + "com.amazonaws.scheduler#PlacementConstraintExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2000 + } + } + }, + "com.amazonaws.scheduler#PlacementConstraintType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "distinctInstance", + "name": "DISTINCT_INSTANCE" + }, + { + "value": "memberOf", + "name": "MEMBER_OF" + } + ] + } + }, + "com.amazonaws.scheduler#PlacementConstraints": { + "type": "list", + "member": { + "target": "com.amazonaws.scheduler#PlacementConstraint" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.scheduler#PlacementStrategies": { + "type": "list", + "member": { + "target": "com.amazonaws.scheduler#PlacementStrategy" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.scheduler#PlacementStrategy": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.scheduler#PlacementStrategyType", + "traits": { + "smithy.api#documentation": "The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates\n evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter.\n For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
" + } + }, + "field": { + "target": "com.amazonaws.scheduler#PlacementStrategyField", + "traits": { + "smithy.api#documentation": "The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId
(or instanceId
, which has the same effect),\n or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone
. For the binpack placement strategy, valid values are\n cpu
and memory
. For the random placement strategy, this field is not used.
The task placement strategy for a task or service.
" + } + }, + "com.amazonaws.scheduler#PlacementStrategyField": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + } + } + }, + "com.amazonaws.scheduler#PlacementStrategyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "random", + "name": "RANDOM" + }, + { + "value": "spread", + "name": "SPREAD" + }, + { + "value": "binpack", + "name": "BINPACK" + } + ] + } + }, + "com.amazonaws.scheduler#PlatformVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.scheduler#PropagateTags": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TASK_DEFINITION", + "name": "TASK_DEFINITION" + } + ] + } + }, + "com.amazonaws.scheduler#ReferenceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.scheduler#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.scheduler#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request references a resource which does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.scheduler#RetryPolicy": { + "type": "structure", + "members": { + "MaximumEventAgeInSeconds": { + "target": "com.amazonaws.scheduler#MaximumEventAgeInSeconds", + "traits": { + "smithy.api#documentation": "The maximum amount of time, in seconds, to continue to make retry attempts.
" + } + }, + "MaximumRetryAttempts": { + "target": "com.amazonaws.scheduler#MaximumRetryAttempts", + "traits": { + "smithy.api#documentation": "The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or\n until the duration of the MaximumEventAgeInSeconds
is reached.
A RetryPolicy
object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
Name of parameter to start execution of a SageMaker Model Building Pipeline.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.scheduler#SageMakerPipelineParameterValue", + "traits": { + "smithy.api#documentation": "Value of parameter to start execution of a SageMaker Model Building Pipeline.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.
" + } + }, + "com.amazonaws.scheduler#SageMakerPipelineParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.scheduler#SageMakerPipelineParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.scheduler#SageMakerPipelineParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.scheduler#SageMakerPipelineParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.scheduler#SageMakerPipelineParameters": { + "type": "structure", + "members": { + "PipelineParameterList": { + "target": "com.amazonaws.scheduler#SageMakerPipelineParameterList", + "traits": { + "smithy.api#documentation": "List of parameter names and values to use when executing the SageMaker Model Building Pipeline.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The templated target type for the Amazon SageMaker \n StartPipelineExecution
\n API operation.
The Amazon Resource Name (ARN) of the schedule group.
" + } + }, + "Name": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group.
" + } + }, + "State": { + "target": "com.amazonaws.scheduler#ScheduleGroupState", + "traits": { + "smithy.api#documentation": "Specifies the state of the schedule group.
" + } + }, + "CreationDate": { + "target": "com.amazonaws.scheduler#CreationDate", + "traits": { + "smithy.api#documentation": "The time at which the schedule group was created.
" + } + }, + "LastModificationDate": { + "target": "com.amazonaws.scheduler#LastModificationDate", + "traits": { + "smithy.api#documentation": "The time at which the schedule group was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a schedule group.
" + } + }, + "com.amazonaws.scheduler#ScheduleList": { + "type": "list", + "member": { + "target": "com.amazonaws.scheduler#ScheduleSummary" + } + }, + "com.amazonaws.scheduler#ScheduleState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.scheduler#ScheduleSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.scheduler#ScheduleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule.
" + } + }, + "Name": { + "target": "com.amazonaws.scheduler#Name", + "traits": { + "smithy.api#documentation": "The name of the schedule.
" + } + }, + "GroupName": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group associated with this schedule.
" + } + }, + "State": { + "target": "com.amazonaws.scheduler#ScheduleState", + "traits": { + "smithy.api#documentation": "Specifies whether the schedule is enabled or disabled.
" + } + }, + "CreationDate": { + "target": "com.amazonaws.scheduler#CreationDate", + "traits": { + "smithy.api#documentation": "The time at which the schedule was created.
" + } + }, + "LastModificationDate": { + "target": "com.amazonaws.scheduler#LastModificationDate", + "traits": { + "smithy.api#documentation": "The time at which the schedule was last modified.
" + } + }, + "Target": { + "target": "com.amazonaws.scheduler#TargetSummary", + "traits": { + "smithy.api#documentation": "The schedule's target details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a schedule.
" + } + }, + "com.amazonaws.scheduler#SecurityGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.scheduler#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.scheduler#SecurityGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.scheduler#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request exceeds a service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.scheduler#Source": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(?=[/\\.\\-_A-Za-z0-9]+)((?!aws\\.).*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + } + }, + "com.amazonaws.scheduler#SqsParameters": { + "type": "structure", + "members": { + "MessageGroupId": { + "target": "com.amazonaws.scheduler#MessageGroupId", + "traits": { + "smithy.api#documentation": "The FIFO message group ID to use as the target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The templated target type for the Amazon SQS \n SendMessage
\n API operation.\n Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled.\n For more information, see Using the Amazon SQS message deduplication ID in the\n Amazon SQS Developer Guide.\n
The key for the tag.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.scheduler#TagValue", + "traits": { + "smithy.api#documentation": "The value for the tag.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Tag to associate with a schedule group.
" + } + }, + "com.amazonaws.scheduler#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.scheduler#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.scheduler#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.scheduler#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.scheduler#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.scheduler#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.scheduler#TagKey" + }, + "value": { + "target": "com.amazonaws.scheduler#TagValue" + } + }, + "com.amazonaws.scheduler#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.scheduler#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#ConflictException" + }, + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tags/{ResourceArn}" + } + } + }, + "com.amazonaws.scheduler#TagResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)?:scheduler:[a-z0-9\\-]+:\\d{12}:schedule-group\\/[0-9a-zA-Z-_.]+$" + } + }, + "com.amazonaws.scheduler#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.scheduler#TagResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule group that you are adding tags to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.scheduler#TagList", + "traits": { + "smithy.api#documentation": "The list of tags to associate with the schedule group.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.scheduler#TagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.scheduler#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.scheduler#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.scheduler#TagMap" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.scheduler#Target": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.scheduler#TargetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.scheduler#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
", + "smithy.api#required": {} + } + }, + "DeadLetterConfig": { + "target": "com.amazonaws.scheduler#DeadLetterConfig", + "traits": { + "smithy.api#documentation": "An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
" + } + }, + "RetryPolicy": { + "target": "com.amazonaws.scheduler#RetryPolicy", + "traits": { + "smithy.api#documentation": "A RetryPolicy
object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target,\n the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler\n delivers a default notification to the target.
" + } + }, + "EcsParameters": { + "target": "com.amazonaws.scheduler#EcsParameters", + "traits": { + "smithy.api#documentation": "The templated target type for the Amazon ECS \n RunTask
\n API operation.
The templated target type for the EventBridge \n PutEvents
\n API operation.
The templated target type for the Amazon Kinesis \n PutRecord
\n API operation.
The templated target type for the Amazon SageMaker \n StartPipelineExecution
\n API operation.
The templated target type for the Amazon SQS \n SendMessage
\n API operation.\n Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled.\n For more information, see Using the Amazon SQS message deduplication ID in the\n Amazon SQS Developer Guide.
The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to\n invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.
" + } + }, + "com.amazonaws.scheduler#TargetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.scheduler#TargetInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.scheduler#TargetPartitionKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.scheduler#TargetSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.scheduler#TargetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a target.
" + } + }, + "com.amazonaws.scheduler#TaskCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.scheduler#TaskDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + } + } + }, + "com.amazonaws.scheduler#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.scheduler#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.scheduler#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#ConflictException" + }, + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes one or more tags from the specified EventBridge Scheduler schedule group.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.scheduler#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.scheduler#TagResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule group from which you are removing tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.scheduler#TagKeyList", + "traits": { + "smithy.api#documentation": "The list of tag keys to remove from the resource.
", + "smithy.api#httpQuery": "TagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.scheduler#UntagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.scheduler#UpdateSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.scheduler#UpdateScheduleInput" + }, + "output": { + "target": "com.amazonaws.scheduler#UpdateScheduleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.scheduler#ConflictException" + }, + { + "target": "com.amazonaws.scheduler#InternalServerException" + }, + { + "target": "com.amazonaws.scheduler#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.scheduler#ThrottlingException" + }, + { + "target": "com.amazonaws.scheduler#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "scheduler:TagResource", + "scheduler:UntagResource" + ], + "smithy.api#documentation": "\n Updates the specified schedule. When you call UpdateSchedule
, EventBridge Scheduler uses all values, including empty values, specified in the request and\n overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to\n its system-default value after the update.\n
\n Before calling this operation, we recommend that you call the GetSchedule
API operation and make a note of all optional parameters\n for your UpdateSchedule
call.\n
The name of the schedule that you are updating.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.scheduler#ScheduleGroupName", + "traits": { + "smithy.api#documentation": "The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update.\n If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.
" + } + }, + "ScheduleExpression": { + "target": "com.amazonaws.scheduler#ScheduleExpression", + "traits": { + "smithy.api#documentation": "\n The expression that defines when the schedule runs. The following formats are supported.\n
\n\n at
expression - at(yyyy-mm-ddThh:mm:ss)
\n
\n rate
expression - rate(unit value)
\n
\n cron
expression - cron(fields)
\n
\n You can use at
expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate
and cron
expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n
\n A cron
expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year)
.\n
\n A rate
expression consists of a value as a positive integer, and a unit with the following options:\n minute
| minutes
| hour
| hours
| day
| days
\n
\n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n
", + "smithy.api#required": {} + } + }, + "StartDate": { + "target": "com.amazonaws.scheduler#StartDate", + "traits": { + "smithy.api#documentation": "The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate
you specify.\nEventBridge Scheduler ignores StartDate
for one-time schedules.
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate
you specify.\nEventBridge Scheduler ignores EndDate
for one-time schedules.
The description you specify for the schedule.
" + } + }, + "ScheduleExpressionTimezone": { + "target": "com.amazonaws.scheduler#ScheduleExpressionTimezone", + "traits": { + "smithy.api#documentation": "The timezone in which the scheduling expression is evaluated.
" + } + }, + "State": { + "target": "com.amazonaws.scheduler#ScheduleState", + "traits": { + "smithy.api#documentation": "Specifies whether the schedule is enabled or disabled.
" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.scheduler#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.
" + } + }, + "Target": { + "target": "com.amazonaws.scheduler#Target", + "traits": { + "smithy.api#documentation": "The schedule target. You can use this operation to change the target that your schedule invokes.
", + "smithy.api#required": {} + } + }, + "FlexibleTimeWindow": { + "target": "com.amazonaws.scheduler#FlexibleTimeWindow", + "traits": { + "smithy.api#documentation": "Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.scheduler#ClientToken", + "traits": { + "smithy.api#documentation": "\n Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,\n EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. \n
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.scheduler#UpdateScheduleOutput": { + "type": "structure", + "members": { + "ScheduleArn": { + "target": "com.amazonaws.scheduler#ScheduleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule that you updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.scheduler#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} \ No newline at end of file