diff --git a/apis/appsync/2017-07-25/docs-2.json b/apis/appsync/2017-07-25/docs-2.json index 10be6b47e61..ffaf5ecdb1d 100644 --- a/apis/appsync/2017-07-25/docs-2.json +++ b/apis/appsync/2017-07-25/docs-2.json @@ -675,7 +675,7 @@ "base": null, "refs": { "CreateDataSourceRequest$type": "
The type of the DataSource
.
The type of the data source.
AWS_LAMBDA: The data source is an Lambda function.
AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
HTTP: The data source is an HTTP endpoint.
RELATIONAL_DATABASE: The data source is a relational database.
The type of the data source.
AWS_LAMBDA: The data source is an Lambda function.
AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
AMAZON_BEDROCK_RUNTIME: The data source is the Amazon Bedrock runtime.
NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.
HTTP: The data source is an HTTP endpoint.
RELATIONAL_DATABASE: The data source is a relational database.
The new data source type.
" } }, diff --git a/apis/cognito-idp/2016-04-18/api-2.json b/apis/cognito-idp/2016-04-18/api-2.json index c2e4f1023de..4d19f03720a 100644 --- a/apis/cognito-idp/2016-04-18/api-2.json +++ b/apis/cognito-idp/2016-04-18/api-2.json @@ -6040,8 +6040,7 @@ "type":"structure", "required":[ "Domain", - "UserPoolId", - "CustomDomainConfig" + "UserPoolId" ], "members":{ "Domain":{"shape":"DomainType"}, diff --git a/apis/ec2/2016-11-15/api-2.json b/apis/ec2/2016-11-15/api-2.json index 3c7593a88a9..f1209bd0995 100644 --- a/apis/ec2/2016-11-15/api-2.json +++ b/apis/ec2/2016-11-15/api-2.json @@ -4799,6 +4799,15 @@ "input":{"shape":"ModifyInstanceMetadataOptionsRequest"}, "output":{"shape":"ModifyInstanceMetadataOptionsResult"} }, + "ModifyInstanceNetworkPerformanceOptions":{ + "name":"ModifyInstanceNetworkPerformanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceNetworkPerformanceRequest"}, + "output":{"shape":"ModifyInstanceNetworkPerformanceResult"} + }, "ModifyInstancePlacement":{ "name":"ModifyInstancePlacement", "http":{ @@ -8450,6 +8459,21 @@ "locationName":"item" } }, + "BandwidthWeightingType":{ + "type":"string", + "enum":[ + "default", + "vpc-1", + "ebs-1" + ] + }, + "BandwidthWeightingTypeList":{ + "type":"list", + "member":{ + "shape":"BandwidthWeightingType", + "locationName":"item" + } + }, "BareMetal":{ "type":"string", "enum":[ @@ -28137,6 +28161,10 @@ "shape":"InstanceBootModeValues", "locationName":"currentInstanceBootMode" }, + "NetworkPerformanceOptions":{ + "shape":"InstanceNetworkPerformanceOptions", + "locationName":"networkPerformanceOptions" + }, "Operator":{ "shape":"OperatorResponse", "locationName":"operator" @@ -28346,6 +28374,14 @@ "default" ] }, + "InstanceBandwidthWeighting":{ + "type":"string", + "enum":[ + "default", + "vpc-1", + "ebs-1" + ] + }, "InstanceBlockDeviceMapping":{ "type":"structure", "members":{ @@ -29248,6 +29284,21 @@ "locationName":"item" } }, + "InstanceNetworkPerformanceOptions":{ + "type":"structure", + "members":{ + "BandwidthWeighting":{ + "shape":"InstanceBandwidthWeighting", + "locationName":"bandwidthWeighting" + } + } + }, + "InstanceNetworkPerformanceOptionsRequest":{ + "type":"structure", + "members":{ + "BandwidthWeighting":{"shape":"InstanceBandwidthWeighting"} + } + }, "InstancePrivateIpAddress":{ "type":"structure", "members":{ @@ -33368,6 +33419,21 @@ "locationName":"item" } }, + "LaunchTemplateNetworkPerformanceOptions":{ + "type":"structure", + "members":{ + "BandwidthWeighting":{ + "shape":"InstanceBandwidthWeighting", + "locationName":"bandwidthWeighting" + } + } + }, + "LaunchTemplateNetworkPerformanceOptionsRequest":{ + "type":"structure", + "members":{ + "BandwidthWeighting":{"shape":"InstanceBandwidthWeighting"} + } + }, "LaunchTemplateOverrides":{ "type":"structure", "members":{ @@ -35191,6 +35257,31 @@ } } }, + "ModifyInstanceNetworkPerformanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "BandwidthWeighting" + ], + "members":{ + "InstanceId":{"shape":"InstanceId"}, + "BandwidthWeighting":{"shape":"InstanceBandwidthWeighting"}, + "DryRun":{"shape":"Boolean"} + } + }, + "ModifyInstanceNetworkPerformanceResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "locationName":"instanceId" + }, + "BandwidthWeighting":{ + "shape":"InstanceBandwidthWeighting", + "locationName":"bandwidthWeighting" + } + } + }, "ModifyInstancePlacementRequest":{ "type":"structure", "required":["InstanceId"], @@ -37074,6 +37165,10 @@ "EnaSrdSupported":{ "shape":"EnaSrdSupported", "locationName":"enaSrdSupported" + }, + "BandwidthWeightings":{ + "shape":"BandwidthWeightingTypeList", + "locationName":"bandwidthWeightings" } } }, @@ -40684,7 +40779,8 @@ "PrivateDnsNameOptions":{"shape":"LaunchTemplatePrivateDnsNameOptionsRequest"}, "MaintenanceOptions":{"shape":"LaunchTemplateInstanceMaintenanceOptionsRequest"}, "DisableApiStop":{"shape":"Boolean"}, - "Operator":{"shape":"OperatorRequest"} + "Operator":{"shape":"OperatorRequest"}, + "NetworkPerformanceOptions":{"shape":"LaunchTemplateNetworkPerformanceOptionsRequest"} } }, "RequestSpotFleetRequest":{ @@ -41749,6 +41845,10 @@ "Operator":{ "shape":"OperatorResponse", "locationName":"operator" + }, + "NetworkPerformanceOptions":{ + "shape":"LaunchTemplateNetworkPerformanceOptions", + "locationName":"networkPerformanceOptions" } } }, @@ -42456,6 +42556,7 @@ "MaintenanceOptions":{"shape":"InstanceMaintenanceOptionsRequest"}, "DisableApiStop":{"shape":"Boolean"}, "EnablePrimaryIpv6":{"shape":"Boolean"}, + "NetworkPerformanceOptions":{"shape":"InstanceNetworkPerformanceOptionsRequest"}, "Operator":{"shape":"OperatorRequest"}, "DryRun":{ "shape":"Boolean", diff --git a/apis/ec2/2016-11-15/docs-2.json b/apis/ec2/2016-11-15/docs-2.json index 5470494f46b..d1e087f3fd4 100644 --- a/apis/ec2/2016-11-15/docs-2.json +++ b/apis/ec2/2016-11-15/docs-2.json @@ -286,7 +286,7 @@ "DescribeInstanceEventWindows": "Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
", "DescribeInstanceImageMetadata": "Describes the AMI that was used to launch an instance, even if the AMI is deprecated, deregistered, made private (no longer public or shared with your account), or not allowed.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance.
If you specify an instance ID that is not valid, an instance that doesn't exist, or an instance that you do not own, an error (InvalidInstanceID.NotFound
) is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
In the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected Availability Zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs that are in an unaffected Availability Zone, the call works normally.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
hpc6a.48xlarge
| hpc6id.32xlarge
| hpc7a.12xlarge
| hpc7a.24xlarge
| hpc7a.48xlarge
| hpc7a.96xlarge
| hpc7g.4xlarge
| hpc7g.8xlarge
| hpc7g.16xlarge
p3dn.24xlarge
| p4d.24xlarge
| p4de.24xlarge
| p5.48xlarge
| p5e.48xlarge
trn1.2xlarge
| trn1.32xlarge
| trn1n.32xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
", + "DescribeInstanceTopology": "Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
hpc6a.48xlarge
| hpc6id.32xlarge
| hpc7a.12xlarge
| hpc7a.24xlarge
| hpc7a.48xlarge
| hpc7a.96xlarge
| hpc7g.4xlarge
| hpc7g.8xlarge
| hpc7g.16xlarge
p3dn.24xlarge
| p4d.24xlarge
| p4de.24xlarge
| p5.48xlarge
| p5e.48xlarge
| p5en.48xlarge
trn1.2xlarge
| trn1.32xlarge
| trn1n.32xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
", "DescribeInstanceTypeOfferings": "Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
", "DescribeInstanceTypes": "Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
", "DescribeInstances": "Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.
", "ModifyInstanceMetadataDefaults": "Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference
. If an account-level setting is cleared with no-preference
, then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
", + "ModifyInstanceNetworkPerformanceOptions": "Change the configuration of the network performance options for an existing instance.
", "ModifyInstancePlacement": "Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host
and the instance is not associated with a specific Dedicated Host, the next time the instance is started, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped
state.
Modify the configurations of an IPAM.
", "ModifyIpamPool": "Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
", @@ -1966,6 +1967,18 @@ "AvailableCapacity$AvailableInstanceCapacity": "The number of instances that can be launched onto the Dedicated Host depending on the host's available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.
" } }, + "BandwidthWeightingType": { + "base": null, + "refs": { + "BandwidthWeightingTypeList$member": null + } + }, + "BandwidthWeightingTypeList": { + "base": null, + "refs": { + "NetworkInfo$BandwidthWeightings": "A list of valid settings for configurable bandwidth weighting for the instance type, if supported.
" + } + }, "BareMetal": { "base": null, "refs": { @@ -2819,6 +2832,7 @@ "ModifyInstanceMetadataDefaultsRequest$DryRun": "Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
If the request succeeds, the response returns true
. If the request fails, no response is returned, and instead an error message is returned.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Is true
if the request succeeds, and an error otherwise.
A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
", @@ -10164,8 +10178,8 @@ "DescribeInstanceStatusRequest$Filters": "The filters.
availability-zone
- The Availability Zone of the instance.
event.code
- The code for the scheduled event (instance-reboot
| system-reboot
| system-maintenance
| instance-retirement
| instance-stop
).
event.description
- A description of the event.
event.instance-event-id
- The ID of the event whose date and time you are modifying.
event.not-after
- The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z
).
event.not-before
- The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z
).
event.not-before-deadline
- The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z
).
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the instance (pending
| running
| shutting-down
| terminated
| stopping
| stopped
).
instance-status.reachability
- Filters on instance status where the name is reachability
(passed
| failed
| initializing
| insufficient-data
).
instance-status.status
- The status of the instance (ok
| impaired
| initializing
| insufficient-data
| not-applicable
).
operator.managed
- A Boolean that indicates whether this is a managed instance.
operator.principal
- The principal that manages the instance. Only valid for managed instances, where managed
is true
.
system-status.reachability
- Filters on system status where the name is reachability
(passed
| failed
| initializing
| insufficient-data
).
system-status.status
- The system status of the instance (ok
| impaired
| initializing
| insufficient-data
| not-applicable
).
attached-ebs-status.status
- The status of the attached EBS volume for the instance (ok
| impaired
| initializing
| insufficient-data
| not-applicable
).
The filters.
availability-zone
- The name of the Availability Zone (for example, us-west-2a
) or Local Zone (for example, us-west-2-lax-1b
) that the instance is in.
instance-type
- The instance type (for example, p4d.24xlarge
) or instance family (for example, p4d*
). You can use the *
wildcard to match zero or more characters, or the ?
wildcard to match zero or one character.
zone-id
- The ID of the Availability Zone (for example, usw2-az2
) or Local Zone (for example, usw2-lax1-az1
) that the instance is in.
One or more filters. Filter names and values are case-sensitive.
instance-type
- The instance type. For a list of possible values, see Instance.
location
- The location. For a list of possible identifiers, see Regions and Zones.
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported
- Indicates whether Amazon CloudWatch action based recovery is supported (true
| false
).
bare-metal
- Indicates whether it is a bare metal instance type (true
| false
).
burstable-performance-supported
- Indicates whether the instance type is a burstable performance T instance type (true
| false
).
current-generation
- Indicates whether this instance type is the latest generation instance type of an instance family (true
| false
).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps
- The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops
- The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps
- The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps
- The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops
- The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps
- The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support
- Indicates whether the instance type is EBS-optimized (supported
| unsupported
| default
).
ebs-info.encryption-support
- Indicates whether EBS encryption is supported (supported
| unsupported
).
ebs-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required
| supported
| unsupported
).
free-tier-eligible
- Indicates whether the instance type is eligible to use in the free tier (true
| false
).
hibernation-supported
- Indicates whether On-Demand hibernation is supported (true
| false
).
hypervisor
- The hypervisor (nitro
| xen
).
instance-storage-info.disk.count
- The number of local disks.
instance-storage-info.disk.size-in-gb
- The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type
- The storage technology for the local instance storage disks (hdd
| ssd
).
instance-storage-info.encryption-support
- Indicates whether data is encrypted at rest (required
| supported
| unsupported
).
instance-storage-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is supported for instance store (required
| supported
| unsupported
).
instance-storage-info.total-size-in-gb
- The total amount of storage available from all local instance storage, in GB.
instance-storage-supported
- Indicates whether the instance type has local instance storage (true
| false
).
instance-type
- The instance type (for example c5.2xlarge
or c5*).
memory-info.size-in-mib
- The memory size.
network-info.efa-info.maximum-efa-interfaces
- The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported
- Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true
| false
).
network-info.ena-support
- Indicates whether Elastic Network Adapter (ENA) is supported or required (required
| supported
| unsupported
).
network-info.encryption-in-transit-supported
- Indicates whether the instance type automatically encrypts in-transit traffic between instances (true
| false
).
network-info.ipv4-addresses-per-interface
- The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface
- The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported
- Indicates whether the instance type supports IPv6 (true
| false
).
network-info.maximum-network-cards
- The maximum number of network cards per instance.
network-info.maximum-network-interfaces
- The maximum number of network interfaces per instance.
network-info.network-performance
- The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support
- Indicates whether Nitro Enclaves is supported (supported
| unsupported
).
nitro-tpm-support
- Indicates whether NitroTPM is supported (supported
| unsupported
).
nitro-tpm-info.supported-versions
- The supported NitroTPM version (2.0
).
processor-info.supported-architecture
- The CPU architecture (arm64
| i386
| x86_64
).
processor-info.sustained-clock-speed-in-ghz
- The CPU clock speed, in GHz.
processor-info.supported-features
- The supported CPU features (amd-sev-snp
).
supported-boot-mode
- The boot mode (legacy-bios
| uefi
).
supported-root-device-type
- The root device type (ebs
| instance-store
).
supported-usage-class
- The usage class (on-demand
| spot
| capacity-block
).
supported-virtualization-type
- The virtualization type (hvm
| paravirtual
).
vcpu-info.default-cores
- The default number of cores for the instance type.
vcpu-info.default-threads-per-core
- The default number of threads per core for the instance type.
vcpu-info.default-vcpus
- The default number of vCPUs for the instance type.
vcpu-info.valid-cores
- The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core
- The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
The filters.
affinity
- The affinity setting for an instance running on a Dedicated Host (default
| host
).
architecture
- The instance architecture (i386
| x86_64
| arm64
).
availability-zone
- The Availability Zone of the instance.
block-device-mapping.attach-time
- The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z
.
block-device-mapping.delete-on-termination
- A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name
- The device name specified in the block device mapping (for example, /dev/sdh
or xvdh
).
block-device-mapping.status
- The status for the EBS volume (attaching
| attached
| detaching
| detached
).
block-device-mapping.volume-id
- The volume ID of the EBS volume.
boot-mode
- The boot mode that was specified by the AMI (legacy-bios
| uefi
| uefi-preferred
).
capacity-reservation-id
- The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference
- The instance's Capacity Reservation preference (open
| none
).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id
- The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
- The ARN of the targeted Capacity Reservation group.
client-token
- The idempotency token you provided when you launched the instance.
current-instance-boot-mode
- The boot mode that is used to launch the instance at launch or start (legacy-bios
| uefi
).
dns-name
- The public DNS name of the instance.
ebs-optimized
- A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support
- A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled
- A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured
- A Boolean that indicates whether the instance is enabled for hibernation. A value of true
means that the instance is enabled for hibernation.
host-id
- The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor
- The hypervisor type of the instance (ovm
| xen
). The value xen
is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn
- The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id
- The instance profile associated with the instance. Specified as an ID.
image-id
- The ID of the image used to launch the instance.
instance-id
- The ID of the instance.
instance-lifecycle
- Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot
| scheduled
| capacity-block
).
instance-state-code
- The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the instance (pending
| running
| shutting-down
| terminated
| stopping
| stopped
).
instance-type
- The type of instance (for example, t2.micro
).
instance.group-id
- The ID of the security group for the instance.
instance.group-name
- The name of the security group for the instance.
ip-address
- The public IPv4 address of the instance.
ipv6-address
- The IPv6 address of the instance.
kernel-id
- The kernel ID.
key-name
- The name of the key pair used when the instance was launched.
launch-index
- When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time
- The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z
. You can use a wildcard (*
), for example, 2021-09-29T*
, which matches an entire day.
maintenance-options.auto-recovery
- The current automatic recovery behavior of the instance (disabled
| default
).
metadata-options.http-endpoint
- The status of access to the HTTP metadata endpoint on your instance (enabled
| disabled
)
metadata-options.http-protocol-ipv4
- Indicates whether the IPv4 endpoint is enabled (disabled
| enabled
).
metadata-options.http-protocol-ipv6
- Indicates whether the IPv6 endpoint is enabled (disabled
| enabled
).
metadata-options.http-put-response-hop-limit
- The HTTP metadata request put response hop limit (integer, possible values 1
to 64
)
metadata-options.http-tokens
- The metadata request authorization state (optional
| required
)
metadata-options.instance-metadata-tags
- The status of access to instance tags from the instance metadata (enabled
| disabled
)
metadata-options.state
- The state of the metadata option changes (pending
| applied
).
monitoring-state
- Indicates whether detailed monitoring is enabled (disabled
| enabled
).
network-interface.addresses.association.allocation-id
- The allocation ID.
network-interface.addresses.association.association-id
- The association ID.
network-interface.addresses.association.carrier-ip
- The carrier IP address.
network-interface.addresses.association.customer-owned-ip
- The customer-owned IP address.
network-interface.addresses.association.ip-owner-id
- The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name
- The public DNS name.
network-interface.addresses.association.public-ip
- The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary
- Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name
- The private DNS name.
network-interface.addresses.private-ip-address
- The private IPv4 address associated with the network interface.
network-interface.association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id
- The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip
- The customer-owned IP address.
network-interface.association.customer-owned-ip
- The customer-owned IP address.
network-interface.association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name
- The public DNS name.
network-interface.association.public-ip
- The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time
- The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id
- The ID of the interface attachment.
network-interface.attachment.delete-on-termination
- Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index
- The device index to which the network interface is attached.
network-interface.attachment.instance-id
- The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id
- The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index
- The index of the network card.
network-interface.attachment.status
- The status of the attachment (attaching
| attached
| detaching
| detached
).
network-interface.availability-zone
- The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic
- A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description
- The description of the network interface.
network-interface.group-id
- The ID of a security group associated with the network interface.
network-interface.group-name
- The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix
- The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address
- The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address
- The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6
- A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native
- A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix
- The IPv6 prefix assigned to the network interface.
network-interface.mac-address
- The MAC address of the network interface.
network-interface.network-interface-id
- The ID of the network interface.
network-interface.operator.managed
- A Boolean that indicates whether the instance has a managed network interface.
network-interface.operator.principal
- The principal that manages the network interface. Only valid for instances with managed network interfaces, where managed
is true
.
network-interface.outpost-arn
- The ARN of the Outpost.
network-interface.owner-id
- The ID of the owner of the network interface.
network-interface.private-dns-name
- The private DNS name of the network interface.
network-interface.private-ip-address
- The private IPv4 address.
network-interface.public-dns-name
- The public DNS name.
network-interface.requester-id
- The requester ID for the network interface.
network-interface.requester-managed
- Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status
- The status of the network interface (available
) | in-use
).
network-interface.source-dest-check
- Whether the network interface performs source/destination checking. A value of true
means that checking is enabled, and false
means that checking is disabled. The value must be false
for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id
- The ID of the subnet for the network interface.
network-interface.tag-key
- The key of a tag assigned to the network interface.
network-interface.tag-value
- The value of a tag assigned to the network interface.
network-interface.vpc-id
- The ID of the VPC for the network interface.
operator.managed
- A Boolean that indicates whether this is a managed instance.
operator.principal
- The principal that manages the instance. Only valid for managed instances, where managed
is true
.
outpost-arn
- The Amazon Resource Name (ARN) of the Outpost.
owner-id
- The Amazon Web Services account ID of the instance owner.
placement-group-name
- The name of the placement group for the instance.
placement-partition-number
- The partition in which the instance is located.
platform
- The platform. To list only Windows instances, use windows
.
platform-details
- The platform (Linux/UNIX
| Red Hat BYOL Linux
| Red Hat Enterprise Linux
| Red Hat Enterprise Linux with HA
| Red Hat Enterprise Linux with SQL Server Standard and HA
| Red Hat Enterprise Linux with SQL Server Enterprise and HA
| Red Hat Enterprise Linux with SQL Server Standard
| Red Hat Enterprise Linux with SQL Server Web
| Red Hat Enterprise Linux with SQL Server Enterprise
| SQL Server Enterprise
| SQL Server Standard
| SQL Server Web
| SUSE Linux
| Ubuntu Pro
| Windows
| Windows BYOL
| Windows with SQL Server Enterprise
| Windows with SQL Server Standard
| Windows with SQL Server Web
).
private-dns-name
- The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record
- A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record
- A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type
- The type of hostname (ip-name
| resource-name
).
private-ip-address
- The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address
.
product-code
- The product code associated with the AMI used to launch the instance.
product-code.type
- The type of product code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
reason
- The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id
- The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id
- The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name
- The device name of the root device volume (for example, /dev/sda1
).
root-device-type
- The type of the root device volume (ebs
| instance-store
).
source-dest-check
- Indicates whether the instance performs source/destination checking. A value of true
means that checking is enabled, and false
means that checking is disabled. The value must be false
for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id
- The ID of the Spot Instance request.
state-reason-code
- The reason code for the state change.
state-reason-message
- A message that describes the state change.
subnet-id
- The ID of the subnet for the instance.
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy
- The tenancy of an instance (dedicated
| default
| host
).
tpm-support
- Indicates if the instance is configured for NitroTPM support (v2.0
).
usage-operation
- The usage operation value for the instance (RunInstances
| RunInstances:00g0
| RunInstances:0010
| RunInstances:1010
| RunInstances:1014
| RunInstances:1110
| RunInstances:0014
| RunInstances:0210
| RunInstances:0110
| RunInstances:0100
| RunInstances:0004
| RunInstances:0200
| RunInstances:000g
| RunInstances:0g00
| RunInstances:0002
| RunInstances:0800
| RunInstances:0102
| RunInstances:0006
| RunInstances:0202
).
usage-operation-update-time
- The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z
.
virtualization-type
- The virtualization type of the instance (paravirtual
| hvm
).
vpc-id
- The ID of the VPC that the instance is running in.
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported
- Indicates whether Amazon CloudWatch action based recovery is supported (true
| false
).
bare-metal
- Indicates whether it is a bare metal instance type (true
| false
).
burstable-performance-supported
- Indicates whether the instance type is a burstable performance T instance type (true
| false
).
current-generation
- Indicates whether this instance type is the latest generation instance type of an instance family (true
| false
).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps
- The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops
- The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps
- The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps
- The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops
- The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps
- The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support
- Indicates whether the instance type is EBS-optimized (supported
| unsupported
| default
).
ebs-info.encryption-support
- Indicates whether EBS encryption is supported (supported
| unsupported
).
ebs-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required
| supported
| unsupported
).
free-tier-eligible
- Indicates whether the instance type is eligible to use in the free tier (true
| false
).
hibernation-supported
- Indicates whether On-Demand hibernation is supported (true
| false
).
hypervisor
- The hypervisor (nitro
| xen
).
instance-storage-info.disk.count
- The number of local disks.
instance-storage-info.disk.size-in-gb
- The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type
- The storage technology for the local instance storage disks (hdd
| ssd
).
instance-storage-info.encryption-support
- Indicates whether data is encrypted at rest (required
| supported
| unsupported
).
instance-storage-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is supported for instance store (required
| supported
| unsupported
).
instance-storage-info.total-size-in-gb
- The total amount of storage available from all local instance storage, in GB.
instance-storage-supported
- Indicates whether the instance type has local instance storage (true
| false
).
instance-type
- The instance type (for example c5.2xlarge
or c5*).
memory-info.size-in-mib
- The memory size.
network-info.bandwidth-weightings
- For instances that support bandwidth weighting to boost performance (default
, vpc-1
, ebs-1
).
network-info.efa-info.maximum-efa-interfaces
- The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported
- Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true
| false
).
network-info.ena-support
- Indicates whether Elastic Network Adapter (ENA) is supported or required (required
| supported
| unsupported
).
network-info.encryption-in-transit-supported
- Indicates whether the instance type automatically encrypts in-transit traffic between instances (true
| false
).
network-info.ipv4-addresses-per-interface
- The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface
- The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported
- Indicates whether the instance type supports IPv6 (true
| false
).
network-info.maximum-network-cards
- The maximum number of network cards per instance.
network-info.maximum-network-interfaces
- The maximum number of network interfaces per instance.
network-info.network-performance
- The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support
- Indicates whether Nitro Enclaves is supported (supported
| unsupported
).
nitro-tpm-support
- Indicates whether NitroTPM is supported (supported
| unsupported
).
nitro-tpm-info.supported-versions
- The supported NitroTPM version (2.0
).
processor-info.supported-architecture
- The CPU architecture (arm64
| i386
| x86_64
).
processor-info.sustained-clock-speed-in-ghz
- The CPU clock speed, in GHz.
processor-info.supported-features
- The supported CPU features (amd-sev-snp
).
supported-boot-mode
- The boot mode (legacy-bios
| uefi
).
supported-root-device-type
- The root device type (ebs
| instance-store
).
supported-usage-class
- The usage class (on-demand
| spot
| capacity-block
).
supported-virtualization-type
- The virtualization type (hvm
| paravirtual
).
vcpu-info.default-cores
- The default number of cores for the instance type.
vcpu-info.default-threads-per-core
- The default number of threads per core for the instance type.
vcpu-info.default-vcpus
- The default number of vCPUs for the instance type.
vcpu-info.valid-cores
- The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core
- The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
The filters.
affinity
- The affinity setting for an instance running on a Dedicated Host (default
| host
).
architecture
- The instance architecture (i386
| x86_64
| arm64
).
availability-zone
- The Availability Zone of the instance.
block-device-mapping.attach-time
- The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z
.
block-device-mapping.delete-on-termination
- A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name
- The device name specified in the block device mapping (for example, /dev/sdh
or xvdh
).
block-device-mapping.status
- The status for the EBS volume (attaching
| attached
| detaching
| detached
).
block-device-mapping.volume-id
- The volume ID of the EBS volume.
boot-mode
- The boot mode that was specified by the AMI (legacy-bios
| uefi
| uefi-preferred
).
capacity-reservation-id
- The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference
- The instance's Capacity Reservation preference (open
| none
).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id
- The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
- The ARN of the targeted Capacity Reservation group.
client-token
- The idempotency token you provided when you launched the instance.
current-instance-boot-mode
- The boot mode that is used to launch the instance at launch or start (legacy-bios
| uefi
).
dns-name
- The public DNS name of the instance.
ebs-optimized
- A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support
- A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled
- A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured
- A Boolean that indicates whether the instance is enabled for hibernation. A value of true
means that the instance is enabled for hibernation.
host-id
- The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor
- The hypervisor type of the instance (ovm
| xen
). The value xen
is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn
- The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id
- The instance profile associated with the instance. Specified as an ID.
image-id
- The ID of the image used to launch the instance.
instance-id
- The ID of the instance.
instance-lifecycle
- Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot
| scheduled
| capacity-block
).
instance-state-code
- The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name
- The state of the instance (pending
| running
| shutting-down
| terminated
| stopping
| stopped
).
instance-type
- The type of instance (for example, t2.micro
).
instance.group-id
- The ID of the security group for the instance.
instance.group-name
- The name of the security group for the instance.
ip-address
- The public IPv4 address of the instance.
ipv6-address
- The IPv6 address of the instance.
kernel-id
- The kernel ID.
key-name
- The name of the key pair used when the instance was launched.
launch-index
- When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time
- The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z
. You can use a wildcard (*
), for example, 2021-09-29T*
, which matches an entire day.
maintenance-options.auto-recovery
- The current automatic recovery behavior of the instance (disabled
| default
).
metadata-options.http-endpoint
- The status of access to the HTTP metadata endpoint on your instance (enabled
| disabled
)
metadata-options.http-protocol-ipv4
- Indicates whether the IPv4 endpoint is enabled (disabled
| enabled
).
metadata-options.http-protocol-ipv6
- Indicates whether the IPv6 endpoint is enabled (disabled
| enabled
).
metadata-options.http-put-response-hop-limit
- The HTTP metadata request put response hop limit (integer, possible values 1
to 64
)
metadata-options.http-tokens
- The metadata request authorization state (optional
| required
)
metadata-options.instance-metadata-tags
- The status of access to instance tags from the instance metadata (enabled
| disabled
)
metadata-options.state
- The state of the metadata option changes (pending
| applied
).
monitoring-state
- Indicates whether detailed monitoring is enabled (disabled
| enabled
).
network-interface.addresses.association.allocation-id
- The allocation ID.
network-interface.addresses.association.association-id
- The association ID.
network-interface.addresses.association.carrier-ip
- The carrier IP address.
network-interface.addresses.association.customer-owned-ip
- The customer-owned IP address.
network-interface.addresses.association.ip-owner-id
- The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name
- The public DNS name.
network-interface.addresses.association.public-ip
- The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary
- Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name
- The private DNS name.
network-interface.addresses.private-ip-address
- The private IPv4 address associated with the network interface.
network-interface.association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id
- The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip
- The customer-owned IP address.
network-interface.association.customer-owned-ip
- The customer-owned IP address.
network-interface.association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name
- The public DNS name.
network-interface.association.public-ip
- The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time
- The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id
- The ID of the interface attachment.
network-interface.attachment.delete-on-termination
- Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index
- The device index to which the network interface is attached.
network-interface.attachment.instance-id
- The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id
- The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index
- The index of the network card.
network-interface.attachment.status
- The status of the attachment (attaching
| attached
| detaching
| detached
).
network-interface.availability-zone
- The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic
- A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description
- The description of the network interface.
network-interface.group-id
- The ID of a security group associated with the network interface.
network-interface.group-name
- The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix
- The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address
- The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address
- The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6
- A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native
- A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix
- The IPv6 prefix assigned to the network interface.
network-interface.mac-address
- The MAC address of the network interface.
network-interface.network-interface-id
- The ID of the network interface.
network-interface.operator.managed
- A Boolean that indicates whether the instance has a managed network interface.
network-interface.operator.principal
- The principal that manages the network interface. Only valid for instances with managed network interfaces, where managed
is true
.
network-interface.outpost-arn
- The ARN of the Outpost.
network-interface.owner-id
- The ID of the owner of the network interface.
network-interface.private-dns-name
- The private DNS name of the network interface.
network-interface.private-ip-address
- The private IPv4 address.
network-interface.public-dns-name
- The public DNS name.
network-interface.requester-id
- The requester ID for the network interface.
network-interface.requester-managed
- Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status
- The status of the network interface (available
) | in-use
).
network-interface.source-dest-check
- Whether the network interface performs source/destination checking. A value of true
means that checking is enabled, and false
means that checking is disabled. The value must be false
for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id
- The ID of the subnet for the network interface.
network-interface.tag-key
- The key of a tag assigned to the network interface.
network-interface.tag-value
- The value of a tag assigned to the network interface.
network-interface.vpc-id
- The ID of the VPC for the network interface.
network-performance-options.bandwidth-weighting
- Where the performance boost is applied, if applicable. Valid values: default
, vpc-1
, ebs-1
.
operator.managed
- A Boolean that indicates whether this is a managed instance.
operator.principal
- The principal that manages the instance. Only valid for managed instances, where managed
is true
.
outpost-arn
- The Amazon Resource Name (ARN) of the Outpost.
owner-id
- The Amazon Web Services account ID of the instance owner.
placement-group-name
- The name of the placement group for the instance.
placement-partition-number
- The partition in which the instance is located.
platform
- The platform. To list only Windows instances, use windows
.
platform-details
- The platform (Linux/UNIX
| Red Hat BYOL Linux
| Red Hat Enterprise Linux
| Red Hat Enterprise Linux with HA
| Red Hat Enterprise Linux with SQL Server Standard and HA
| Red Hat Enterprise Linux with SQL Server Enterprise and HA
| Red Hat Enterprise Linux with SQL Server Standard
| Red Hat Enterprise Linux with SQL Server Web
| Red Hat Enterprise Linux with SQL Server Enterprise
| SQL Server Enterprise
| SQL Server Standard
| SQL Server Web
| SUSE Linux
| Ubuntu Pro
| Windows
| Windows BYOL
| Windows with SQL Server Enterprise
| Windows with SQL Server Standard
| Windows with SQL Server Web
).
private-dns-name
- The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record
- A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record
- A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type
- The type of hostname (ip-name
| resource-name
).
private-ip-address
- The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address
.
product-code
- The product code associated with the AMI used to launch the instance.
product-code.type
- The type of product code (devpay
| marketplace
).
ramdisk-id
- The RAM disk ID.
reason
- The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id
- The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id
- The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name
- The device name of the root device volume (for example, /dev/sda1
).
root-device-type
- The type of the root device volume (ebs
| instance-store
).
source-dest-check
- Indicates whether the instance performs source/destination checking. A value of true
means that checking is enabled, and false
means that checking is disabled. The value must be false
for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id
- The ID of the Spot Instance request.
state-reason-code
- The reason code for the state change.
state-reason-message
- A message that describes the state change.
subnet-id
- The ID of the subnet for the instance.
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy
- The tenancy of an instance (dedicated
| default
| host
).
tpm-support
- Indicates if the instance is configured for NitroTPM support (v2.0
).
usage-operation
- The usage operation value for the instance (RunInstances
| RunInstances:00g0
| RunInstances:0010
| RunInstances:1010
| RunInstances:1014
| RunInstances:1110
| RunInstances:0014
| RunInstances:0210
| RunInstances:0110
| RunInstances:0100
| RunInstances:0004
| RunInstances:0200
| RunInstances:000g
| RunInstances:0g00
| RunInstances:0002
| RunInstances:0800
| RunInstances:0102
| RunInstances:0006
| RunInstances:0202
).
usage-operation-update-time
- The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z
.
virtualization-type
- The virtualization type of the instance (paravirtual
| hvm
).
vpc-id
- The ID of the VPC that the instance is running in.
The filters.
attachment.state
- The current state of the attachment between the gateway and the VPC (available
). Present only if a VPC is attached.
attachment.vpc-id
- The ID of an attached VPC.
internet-gateway-id
- The ID of the Internet gateway.
owner-id
- The ID of the Amazon Web Services account that owns the internet gateway.
tag
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
Available filters:
ipam-arn
ipam-external-resource-verification-token-arn
ipam-external-resource-verification-token-id
ipam-id
ipam-region
state
status
token-name
token-value
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", @@ -10194,7 +10208,7 @@ "DescribeNetworkInsightsAnalysesRequest$Filters": "The filters. The following are the possible values:
path-found - A Boolean value that indicates whether a feasible path is found.
status - The status of the analysis (running | succeeded | failed).
The filters. The following are the possible values:
destination - The ID of the resource.
filter-at-source.source-address - The source IPv4 address at the source.
filter-at-source.source-port-range - The source port range at the source.
filter-at-source.destination-address - The destination IPv4 address at the source.
filter-at-source.destination-port-range - The destination port range at the source.
filter-at-destination.source-address - The source IPv4 address at the destination.
filter-at-destination.source-port-range - The source port range at the destination.
filter-at-destination.destination-address - The destination IPv4 address at the destination.
filter-at-destination.destination-port-range - The destination port range at the destination.
protocol - The protocol.
source - The ID of the resource.
One or more filters.
network-interface-permission.network-interface-permission-id
- The ID of the permission.
network-interface-permission.network-interface-id
- The ID of the network interface.
network-interface-permission.aws-account-id
- The Amazon Web Services account ID.
network-interface-permission.aws-service
- The Amazon Web Services service.
network-interface-permission.permission
- The type of permission (INSTANCE-ATTACH
| EIP-ASSOCIATE
).
One or more filters.
association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.association-id
- The association ID returned when the network interface was associated with an IPv4 address.
addresses.association.owner-id
- The owner ID of the addresses associated with the network interface.
addresses.association.public-ip
- The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.primary
- Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.private-ip-address
- The private IPv4 addresses associated with the network interface.
association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip
- The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name
- The public DNS name for the network interface (IPv4).
attachment.attach-time
- The time that the network interface was attached to an instance.
attachment.attachment-id
- The ID of the interface attachment.
attachment.delete-on-termination
- Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index
- The device index to which the network interface is attached.
attachment.instance-id
- The ID of the instance to which the network interface is attached.
attachment.instance-owner-id
- The owner ID of the instance to which the network interface is attached.
attachment.status
- The status of the attachment (attaching
| attached
| detaching
| detached
).
availability-zone
- The Availability Zone of the network interface.
description
- The description of the network interface.
group-id
- The ID of a security group associated with the network interface.
ipv6-addresses.ipv6-address
- An IPv6 address associated with the network interface.
interface-type
- The type of network interface (api_gateway_managed
| aws_codestar_connections_managed
| branch
| ec2_instance_connect_endpoint
| efa
| efa-only
| efs
| gateway_load_balancer
| gateway_load_balancer_endpoint
| global_accelerator_managed
| interface
| iot_rules_managed
| lambda
| load_balancer
| nat_gateway
| network_load_balancer
| quicksight
| transit_gateway
| trunk
| vpc_endpoint
).
mac-address
- The MAC address of the network interface.
network-interface-id
- The ID of the network interface.
operator.managed
- A Boolean that indicates whether this is a managed network interface.
operator.principal
- The principal that manages the network interface. Only valid for managed network interfaces, where managed
is true
.
owner-id
- The Amazon Web Services account ID of the network interface owner.
private-dns-name
- The private DNS name of the network interface (IPv4).
private-ip-address
- The private IPv4 address or addresses of the network interface.
requester-id
- The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed
- Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check
- Indicates whether the network interface performs source/destination checking. A value of true
means checking is enabled, and false
means checking is disabled. The value must be false
for the network interface to perform network address translation (NAT) in your VPC.
status
- The status of the network interface. If the network interface is not attached to an instance, the status is available
; if a network interface is attached to an instance the status is in-use
.
subnet-id
- The ID of the subnet for the network interface.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC for the network interface.
One or more filters.
association.allocation-id
- The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.association-id
- The association ID returned when the network interface was associated with an IPv4 address.
addresses.association.owner-id
- The owner ID of the addresses associated with the network interface.
addresses.association.public-ip
- The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.primary
- Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.private-ip-address
- The private IPv4 addresses associated with the network interface.
association.ip-owner-id
- The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip
- The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name
- The public DNS name for the network interface (IPv4).
attachment.attach-time
- The time that the network interface was attached to an instance.
attachment.attachment-id
- The ID of the interface attachment.
attachment.delete-on-termination
- Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index
- The device index to which the network interface is attached.
attachment.instance-id
- The ID of the instance to which the network interface is attached.
attachment.instance-owner-id
- The owner ID of the instance to which the network interface is attached.
attachment.status
- The status of the attachment (attaching
| attached
| detaching
| detached
).
availability-zone
- The Availability Zone of the network interface.
description
- The description of the network interface.
group-id
- The ID of a security group associated with the network interface.
ipv6-addresses.ipv6-address
- An IPv6 address associated with the network interface.
interface-type
- The type of network interface (api_gateway_managed
| aws_codestar_connections_managed
| branch
| ec2_instance_connect_endpoint
| efa
| efa-only
| efs
| gateway_load_balancer
| gateway_load_balancer_endpoint
| global_accelerator_managed
| interface
| iot_rules_managed
| lambda
| load_balancer
| nat_gateway
| network_load_balancer
| quicksight
| transit_gateway
| trunk
| vpc_endpoint
).
mac-address
- The MAC address of the network interface.
network-interface-id
- The ID of the network interface.
owner-id
- The Amazon Web Services account ID of the network interface owner.
private-dns-name
- The private DNS name of the network interface (IPv4).
private-ip-address
- The private IPv4 address or addresses of the network interface.
requester-id
- The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed
- Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check
- Indicates whether the network interface performs source/destination checking. A value of true
means checking is enabled, and false
means checking is disabled. The value must be false
for the network interface to perform network address translation (NAT) in your VPC.
status
- The status of the network interface. If the network interface is not attached to an instance, the status is available
; if a network interface is attached to an instance the status is in-use
.
subnet-id
- The ID of the subnet for the network interface.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id
- The ID of the VPC for the network interface.
The filters.
group-name
- The name of the placement group.
group-arn
- The Amazon Resource Name (ARN) of the placement group.
spread-level
- The spread level for the placement group (host
| rack
).
state
- The state of the placement group (pending
| available
| deleting
| deleted
).
strategy
- The strategy of the placement group (cluster
| spread
| partition
).
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
One or more filters.
prefix-list-id
: The ID of a prefix list.
prefix-list-name
: The name of a prefix list.
One or more filters.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Provides information on the current automatic recovery behavior of your instance.
" } }, + "InstanceBandwidthWeighting": { + "base": null, + "refs": { + "InstanceNetworkPerformanceOptions$BandwidthWeighting": "When you configure network bandwidth weighting, you can boost your baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type.
", + "InstanceNetworkPerformanceOptionsRequest$BandwidthWeighting": "Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows:
This option uses the standard bandwidth configuration for your instance type.
This option boosts your networking baseline bandwidth and reduces your EBS baseline bandwidth.
This option boosts your EBS baseline bandwidth and reduces your networking baseline bandwidth.
When you configure network bandwidth weighting, you can boost baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type.
", + "LaunchTemplateNetworkPerformanceOptionsRequest$BandwidthWeighting": "Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows:
This option uses the standard bandwidth configuration for your instance type.
This option boosts your networking baseline bandwidth and reduces your EBS baseline bandwidth.
This option boosts your EBS baseline bandwidth and reduces your networking baseline bandwidth.
Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows:
This option uses the standard bandwidth configuration for your instance type.
This option boosts your networking baseline bandwidth and reduces your EBS baseline bandwidth.
This option boosts your EBS baseline bandwidth and reduces your networking baseline bandwidth.
Contains the updated configuration for bandwidth weighting on the specified instance.
" + } + }, "InstanceBlockDeviceMapping": { "base": "Describes a block device mapping.
", "refs": { @@ -12344,6 +12369,8 @@ "ModifyInstanceEventStartTimeRequest$InstanceId": "The ID of the instance with the scheduled event.
", "ModifyInstanceMaintenanceOptionsRequest$InstanceId": "The ID of the instance.
", "ModifyInstanceMetadataOptionsRequest$InstanceId": "The ID of the instance.
", + "ModifyInstanceNetworkPerformanceRequest$InstanceId": "The ID of the instance to update.
", + "ModifyInstanceNetworkPerformanceResult$InstanceId": "The instance ID that was updated.
", "ModifyInstancePlacementRequest$InstanceId": "The ID of the instance that you are modifying.
", "ModifyPrivateDnsNameOptionsRequest$InstanceId": "The ID of the instance.
", "ReplaceRouteRequest$InstanceId": "The ID of a NAT instance in your VPC.
", @@ -12628,6 +12655,18 @@ "SpotFleetLaunchSpecification$NetworkInterfaces": "The network interfaces.
SpotFleetLaunchSpecification
does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead.
With network performance options, you can adjust your bandwidth preferences to meet the needs of the workload that runs on your instance.
", + "refs": { + "Instance$NetworkPerformanceOptions": "Contains settings for the network performance options for your instance.
" + } + }, + "InstanceNetworkPerformanceOptionsRequest": { + "base": "Configure network performance options for your instance that are geared towards performance improvements based on the workload that it runs.
", + "refs": { + "RunInstancesRequest$NetworkPerformanceOptions": "Contains settings for the network performance options for the instance.
" + } + }, "InstancePrivateIpAddress": { "base": "Describes a private IPv4 address.
", "refs": { @@ -14742,6 +14781,18 @@ "DescribeLaunchTemplatesRequest$LaunchTemplateNames": "One or more launch template names.
" } }, + "LaunchTemplateNetworkPerformanceOptions": { + "base": "With network performance options, you can adjust your bandwidth preferences to meet the needs of the workload that runs on your instance at launch.
", + "refs": { + "ResponseLaunchTemplateData$NetworkPerformanceOptions": "Contains the launch template settings for network performance options for your instance.
" + } + }, + "LaunchTemplateNetworkPerformanceOptionsRequest": { + "base": "When you configure network performance options in your launch template, your instance is geared for performance improvements based on the workload that it runs as soon as it's available.
", + "refs": { + "RequestLaunchTemplateData$NetworkPerformanceOptions": "Contains launch template settings to boost network performance for the type of workload that runs on your instance.
" + } + }, "LaunchTemplateOverrides": { "base": "Describes overrides for a launch template.
", "refs": { @@ -15859,6 +15910,16 @@ "refs": { } }, + "ModifyInstanceNetworkPerformanceRequest": { + "base": null, + "refs": { + } + }, + "ModifyInstanceNetworkPerformanceResult": { + "base": null, + "refs": { + } + }, "ModifyInstancePlacementRequest": { "base": null, "refs": { diff --git a/apis/ecs/2014-11-13/docs-2.json b/apis/ecs/2014-11-13/docs-2.json index 673c0a7d965..5093627bb63 100644 --- a/apis/ecs/2014-11-13/docs-2.json +++ b/apis/ecs/2014-11-13/docs-2.json @@ -245,8 +245,8 @@ "ContainerStateChange$exitCode": "The exit code for the container, if the state change is a result of the container exiting.
", "CreateServiceRequest$desiredCount": "The number of instantiations of the specified task definition to place and keep running in your service.
This is required if schedulingStrategy
is REPLICA
or isn't specified. If schedulingStrategy
is DAEMON
then this isn't required.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0
is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds
is unused.
If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
", - "DeploymentConfiguration$maximumPercent": "If a service is using the rolling update (ECS
) deployment type, the maximumPercent
parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING
or PENDING
state during a deployment, as a percentage of the desiredCount
(rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA
service scheduler and has a desiredCount
of four tasks and a maximumPercent
value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent
value for a service using the REPLICA
service scheduler is 200%.
If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types, and tasks in the service use the EC2 launch type, the maximum percent value is set to the default value. The maximum percent value is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state.
You can't specify a custom maximumPercent
value for a service that uses either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and has tasks that use the EC2 launch type.
If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.
", - "DeploymentConfiguration$minimumHealthyPercent": "If a service is using the rolling update (ECS
) deployment type, the minimumHealthyPercent
represents a lower limit on the number of your service's tasks that must remain in the RUNNING
state during a deployment, as a percentage of the desiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount
of four tasks and a minimumHealthyPercent
of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.
For services that do not use a load balancer, the following should be noted:
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING
state before the task is counted towards the minimum healthy percent total.
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services that do use a load balancer, the following should be noted:
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
The default value for a replica service for minimumHealthyPercent
is 100%. The default minimumHealthyPercent
value for a service using the DAEMON
service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.
The minimum number of healthy tasks during a deployment is the desiredCount
multiplied by the minimumHealthyPercent
/100, rounded up to the nearest integer value.
If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value. The minimum healthy percent value is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state.
You can't specify a custom minimumHealthyPercent
value for a service that uses either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and has tasks that use the EC2 launch type.
If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS
) deployment type, the maximumPercent
parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING
or PENDING
state during a deployment, as a percentage of the desiredCount
(rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the REPLICA
service scheduler and has a desiredCount
of four tasks and a maximumPercent
value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default maximumPercent
value for a service using the REPLICA
service scheduler is 200%.
The Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting replacement tasks first and then stopping the unhealthy tasks, as long as cluster resources for starting replacement tasks are available. For more information about how the scheduler replaces unhealthy tasks, see Amazon ECS services.
If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types, and tasks in the service use the EC2 launch type, the maximum percent value is set to the default value. The maximum percent value is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state.
You can't specify a custom maximumPercent
value for a service that uses either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and has tasks that use the EC2 launch type.
If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.
", + "DeploymentConfiguration$minimumHealthyPercent": "If a service is using the rolling update (ECS
) deployment type, the minimumHealthyPercent
represents a lower limit on the number of your service's tasks that must remain in the RUNNING
state during a deployment, as a percentage of the desiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount
of four tasks and a minimumHealthyPercent
of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks.
If any tasks are unhealthy and if maximumPercent
doesn't allow the Amazon ECS scheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one — using the minimumHealthyPercent
as a constraint — to clear up capacity to launch replacement tasks. For more information about how the scheduler replaces unhealthy tasks, see Amazon ECS services .
For services that do not use a load balancer, the following should be noted:
A service is considered healthy if all essential containers within the tasks in the service pass their health checks.
If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a RUNNING
state before the task is counted towards the minimum healthy percent total.
If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings.
For services that do use a load balancer, the following should be noted:
If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.
The default value for a replica service for minimumHealthyPercent
is 100%. The default minimumHealthyPercent
value for a service using the DAEMON
service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.
The minimum number of healthy tasks during a deployment is the desiredCount
multiplied by the minimumHealthyPercent
/100, rounded up to the nearest integer value.
If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value. The minimum healthy percent value is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state.
You can't specify a custom minimumHealthyPercent
value for a service that uses either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and has tasks that use the EC2 launch type.
If a service is using either the blue/green (CODE_DEPLOY
) or EXTERNAL
deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
The maximum number of account setting results returned by DescribeCapacityProviders
in paginated output. When this parameter is used, DescribeCapacityProviders
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders
request with the returned nextToken
value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders
returns up to 10 results and a nextToken
value if applicable.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
", "HealthCheck$interval": "The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
", @@ -325,11 +325,11 @@ "refs": { "Cluster$defaultCapacityProviderStrategy": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
", "CreateClusterRequest$defaultCapacityProviderStrategy": "The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.
", - "CreateServiceRequest$capacityProviderStrategy": "The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
", + "CreateServiceRequest$capacityProviderStrategy": "The capacity provider strategy to use for the service.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
A capacity provider strategy can contain a maximum of 20 capacity providers.
", "CreateTaskSetRequest$capacityProviderStrategy": "The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers along with the base
and weight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE
or UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProviderProviderAPI operation.
To use a Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
", "Deployment$capacityProviderStrategy": "The capacity provider strategy that the deployment is using.
", "PutClusterCapacityProvidersRequest$defaultCapacityProviderStrategy": "The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers along with the base
and weight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE
or UPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The capacity provider strategy to use for the task.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not launchType
.
A capacity provider strategy may contain a maximum of 6 capacity providers.
", + "RunTaskRequest$capacityProviderStrategy": "The capacity provider strategy to use for the task.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
When you use cluster auto scaling, you must specify capacityProviderStrategy
and not launchType
.
A capacity provider strategy can contain a maximum of 20 capacity providers.
", "Service$capacityProviderStrategy": "The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
", "ServiceRevision$capacityProviderStrategy": "The capacity provider strategy the service revision uses.
", "TaskSet$capacityProviderStrategy": "The capacity provider strategy that are associated with the task set.
", @@ -337,7 +337,7 @@ } }, "CapacityProviderStrategyItem": { - "base": "The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTaskor CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster
API.
Only capacity providers that are already associated with a cluster and have an ACTIVE
or UPDATING
status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.
With FARGATE_SPOT
, you can run interruption tolerant tasks at a rate that's discounted compared to the FARGATE
price. FARGATE_SPOT
runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. FARGATE_SPOT
supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. FARGATE_SPOT
supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later.
A capacity provider strategy may contain a maximum of 6 capacity providers.
", + "base": "The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTaskor CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster
API.
Only capacity providers that are already associated with a cluster and have an ACTIVE
or UPDATING
status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.
With FARGATE_SPOT
, you can run interruption tolerant tasks at a rate that's discounted compared to the FARGATE
price. FARGATE_SPOT
runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. FARGATE_SPOT
supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. FARGATE_SPOT
supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later.
A capacity provider strategy can contain a maximum of 20 capacity providers.
", "refs": { "CapacityProviderStrategy$member": null } @@ -2253,7 +2253,7 @@ "DeleteAccountSettingRequest$name": "The resource name to disable the account setting for. If serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking
is specified, the ENI limit for your Amazon ECS container instances is affected.
The name of the account setting you want to list the settings for.
", "PutAccountSettingDefaultRequest$name": "The resource name for which to modify the account setting.
The following are the valid values for the account setting name.
serviceLongArnFormat
- When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.
taskLongArnFormat
- When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.
containerInstanceLongArnFormat
- When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.
awsvpcTrunking
- When modified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking
is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.
containerInsights
- Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up.
To use Container Insights with enhanced observability, set the containerInsights
account setting to enhanced
.
To use Container Insights, set the containerInsights
account setting to enabled
.
For more information, see Monitor Amazon ECS containers using Container Insights with enhanced observability in the Amazon Elastic Container Service Developer Guide.
dualStackIPv6
- When turned on, when using a VPC in dual stack mode, your tasks using the awsvpc
network mode can have an IPv6 address assigned. For more information on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode.
fargateFIPSMode
- If you specify fargateFIPSMode
, Fargate FIPS 140 compliance is affected.
fargateTaskRetirementWaitPeriod
- When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod
to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.
tagResourceAuthorization
- Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster
. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource
action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide.
guardDutyActivate
- The guardDutyActivate
parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The Amazon ECS account setting name to modify.
The following are the valid values for the account setting name.
serviceLongArnFormat
- When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.
taskLongArnFormat
- When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.
containerInstanceLongArnFormat
- When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.
awsvpcTrunking
- When modified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking
is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.
containerInsights
- Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up.
To use Container Insights with enhanced observability, set the containerInsights
account setting to enhanced
.
To use Container Insights, set the containerInsights
account setting to enabled
.
For more information, see Monitor Amazon ECS containers using Container Insights with enhanced observability in the Amazon Elastic Container Service Developer Guide.
dualStackIPv6
- When turned on, when using a VPC in dual stack mode, your tasks using the awsvpc
network mode can have an IPv6 address assigned. For more information on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode.
fargateTaskRetirementWaitPeriod
- When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod
to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.
tagResourceAuthorization
- Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster
. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource
action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide.
guardDutyActivate
- The guardDutyActivate
parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The Amazon ECS account setting name to modify.
The following are the valid values for the account setting name.
serviceLongArnFormat
- When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.
taskLongArnFormat
- When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.
fargateFIPSMode
- When turned on, you can run Fargate workloads in a manner that is compliant with Federal Information Processing Standard (FIPS-140). For more information, see Fargate Federal Information Processing Standard (FIPS-140).
containerInstanceLongArnFormat
- When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.
awsvpcTrunking
- When modified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking
is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.
containerInsights
- Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up.
To use Container Insights with enhanced observability, set the containerInsights
account setting to enhanced
.
To use Container Insights, set the containerInsights
account setting to enabled
.
For more information, see Monitor Amazon ECS containers using Container Insights with enhanced observability in the Amazon Elastic Container Service Developer Guide.
dualStackIPv6
- When turned on, when using a VPC in dual stack mode, your tasks using the awsvpc
network mode can have an IPv6 address assigned. For more information on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode.
fargateTaskRetirementWaitPeriod
- When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod
to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.
tagResourceAuthorization
- Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster
. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource
action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide.
guardDutyActivate
- The guardDutyActivate
parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The Amazon ECS resource name.
" } }, diff --git a/apis/keyspaces/2022-02-10/docs-2.json b/apis/keyspaces/2022-02-10/docs-2.json index eb2aa71da1a..5547551f235 100644 --- a/apis/keyspaces/2022-02-10/docs-2.json +++ b/apis/keyspaces/2022-02-10/docs-2.json @@ -19,7 +19,7 @@ "RestoreTable": "Restores the table to the specified point in time within the earliest_restorable_timestamp
and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.
Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second)
to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.
In addition to the table's schema, data, and TTL settings, RestoreTable
restores the capacity mode, auto scaling settings, encryption settings, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.
You can also overwrite these settings during restore:
Read/write capacity mode
Provisioned throughput capacity units
Auto scaling settings
Point-in-time (PITR) settings
Tags
For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.
Note that the following settings are not restored, and you must configure them manually for the new table:
Identity and Access Management (IAM) policies
Amazon CloudWatch metrics and alarms
Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.
", "UntagResource": "Removes the association of tags from a Amazon Keyspaces resource.
", - "UpdateKeyspace": "Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. The new replica Region is applied to all tables in the keyspace. For more information, see Add an Amazon Web Services Region to a keyspace in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.
To change a single-Region to a multi-Region keyspace, you have to enable client-side timestamps for all tables in the keyspace. For more information, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.
", + "UpdateKeyspace": " Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled
when invoking the API. For more information about client-side timestamps, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.
To add a Region to a keyspace using the UpdateKeyspace
API, the IAM principal needs permissions for the following IAM actions:
cassandra:Alter
cassandra:AlterMultiRegionResource
cassandra:Create
cassandra:CreateMultiRegionResource
cassandra:Select
cassandra:SelectMultiRegionResource
cassandra:Modify
cassandra:ModifyMultiRegionResource
If the keyspace contains a table that is configured in provisioned mode with auto scaling enabled, the following additional IAM actions need to be allowed.
application-autoscaling:RegisterScalableTarget
application-autoscaling:DeregisterScalableTarget
application-autoscaling:DescribeScalableTargets
application-autoscaling:PutScalingPolicy
application-autoscaling:DescribeScalingPolicies
To use the UpdateKeyspace
API, the IAM principal also needs permissions to create a service-linked role with the following elements:
iam:CreateServiceLinkedRole
- The action the principal can perform.
arn:aws:iam::*:role/aws-service-role/replication.cassandra.amazonaws.com/AWSServiceRoleForKeyspacesReplication
- The resource that the action can be performed on.
iam:AWSServiceName: replication.cassandra.amazonaws.com
- The only Amazon Web Services service that this role can be attached to is Amazon Keyspaces.
For more information, see Configure the IAM permissions required to add an Amazon Web Services Region to a keyspace in the Amazon Keyspaces Developer Guide.
", "UpdateTable": "Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
" }, "shapes": { diff --git a/apis/medialive/2017-10-14/api-2.json b/apis/medialive/2017-10-14/api-2.json index 6567ea8a263..0021ab1ed08 100644 --- a/apis/medialive/2017-10-14/api-2.json +++ b/apis/medialive/2017-10-14/api-2.json @@ -9263,6 +9263,10 @@ "MinQp": { "shape": "__integerMin1Max51", "locationName": "minQp" + }, + "Deblocking": { + "shape": "H265Deblocking", + "locationName": "deblocking" } }, "required": [ @@ -15720,7 +15724,10 @@ }, "Tags": { "shape": "Tags", - "locationName": "tags" + "locationName": "tags", + "deprecated": true, + "deprecatedMessage": "This API is deprecated. You must use UpdateTagsForResource instead.", + "deprecatedSince": "2024-11-20" }, "WhitelistRules": { "shape": "__listOfInputWhitelistRuleCidr", @@ -23602,6 +23609,13 @@ "locationName": "scte35PrerollPullupMilliseconds" } } + }, + "H265Deblocking": { + "type": "string", + "enum": [ + "DISABLED", + "ENABLED" + ] } } } \ No newline at end of file diff --git a/apis/medialive/2017-10-14/docs-2.json b/apis/medialive/2017-10-14/docs-2.json index 46b085c3c17..993241dab09 100644 --- a/apis/medialive/2017-10-14/docs-2.json +++ b/apis/medialive/2017-10-14/docs-2.json @@ -6851,6 +6851,12 @@ "refs": { "MultiplexContainerSettings$MultiplexM2tsSettings": null } + }, + "H265Deblocking": { + "base": "H265 Deblocking", + "refs": { + "H265Settings$Deblocking": "Enable or disable the deblocking filter for this codec. The filter reduces blocking artifacts at block boundaries,\nwhich improves overall video quality. If the filter is disabled, visible block edges might appear in the output,\nespecially at lower bitrates." + } } }, "documentation": "API for AWS Elemental MediaLive" diff --git a/apis/workspaces/2015-04-08/docs-2.json b/apis/workspaces/2015-04-08/docs-2.json index 4532f3b4302..061ba2af3a4 100644 --- a/apis/workspaces/2015-04-08/docs-2.json +++ b/apis/workspaces/2015-04-08/docs-2.json @@ -2845,7 +2845,7 @@ "PendingCreateStandbyWorkspacesRequest$UserName": "Describes the standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
", "Workspace$UserName": "The user for the WorkSpace.
", "WorkspaceDirectory$CustomerUserName": "The user name for the service account.
", - "WorkspaceRequest$UserName": "The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
The reserved keyword, [UNDEFINED]
, is used when creating user-decoupled WorkSpaces.
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
The username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.
The reserved keyword, [UNDEFINED]
, is used when creating user-decoupled WorkSpaces.