Returns a list of Batch scheduling policies.
", "ListTagsForResource": "Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
", "RegisterJobDefinition": "Registers an Batch job definition.
", - "SubmitJob": "Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a ResourceRequirements object that's included in the containerOverrides parameter.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.
Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a resourceRequirements object that's included in the containerOverrides parameter.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.
Deletes specified tags from an Batch resource.
", @@ -472,14 +472,14 @@ "ComputeResourceUpdate$maxvCpus": "The maximum number of Amazon EC2 vCPUs that an environment can reach.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.
The desired number of Amazon EC2 vCPUS in the compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirements object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.
For jobs run on EC2 resources that didn't specify memory requirements using resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.
For jobs running on EC2 resources that didn't specify memory requirements using resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.
The exit code to return upon completion.
", - "ContainerOverrides$vcpus": "This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.
This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.
This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.
This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.
The exit code to return upon completion.
", - "CreateComputeEnvironmentRequest$unmanagedvCpus": "The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.
This parameter is only supported when the type parameter is set to UNMANAGED/
The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.
This parameter is only supported when the type parameter is set to UNMANAGED.
The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments 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 DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.
The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.
The name of the CloudWatch Logs log stream associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
The instance type of the underlying host infrastructure of a multi-node parallel job.
This parameter isn't applicable to jobs that are running on Fargate resources.
The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest .
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
", "ContainerProperties$executionRoleArn": "The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.
", "ContainerProperties$user": "The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
Describes an additional detail for a path analysis.
", + "refs": { + "AdditionalDetailList$member": null + } + }, + "AdditionalDetailList": { + "base": null, + "refs": { + "PathComponent$AdditionalDetails": "The additional details.
" + } + }, "Address": { "base": "Describes an Elastic IP address, or a carrier IP address.
", "refs": { @@ -936,6 +948,7 @@ "AnalysisComponent": { "base": "Describes a path component.
", "refs": { + "AdditionalDetail$Component": "The path component.
", "AnalysisComponentList$member": null, "AnalysisLoadBalancerTarget$Instance": "Information about the instance.
", "Explanation$Acl": "The network ACL.
", @@ -961,12 +974,16 @@ "Explanation$VpcEndpoint": "The VPC endpoint.
", "Explanation$VpnConnection": "The VPN connection.
", "Explanation$VpnGateway": "The VPN gateway.
", + "Explanation$TransitGateway": "The transit gateway.
", + "Explanation$TransitGatewayRouteTable": "The transit gateway route table.
", + "Explanation$TransitGatewayAttachment": "The transit gateway attachment.
", "PathComponent$AttachedTo": "The resource to which the path component is attached.
", "PathComponent$Component": "The component.
", "PathComponent$DestinationVpc": "The destination VPC.
", "PathComponent$SourceVpc": "The source VPC.
", "PathComponent$Subnet": "The subnet.
", - "PathComponent$Vpc": "The component VPC.
" + "PathComponent$Vpc": "The component VPC.
", + "PathComponent$TransitGateway": null } }, "AnalysisComponentList": { @@ -3181,9 +3198,6 @@ "CoipPoolId": { "base": null, "refs": { - "CoipPool$PoolId": "The ID of the address pool.
", - "CoipPoolIdSet$member": null, - "GetCoipPoolUsageRequest$PoolId": "The ID of the address pool.
", "ModifySubnetAttributeRequest$CustomerOwnedIpv4Pool": "The customer-owned IPv4 address pool associated with the subnet.
You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
The customer-owned IPv4 address pool associated with the subnet.
" } @@ -7947,8 +7961,8 @@ "DescribeNetworkAclsRequest$Filters": "One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
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 ACL.
There are no supported filters.
", "DescribeNetworkInsightsAccessScopesRequest$Filters": "There are no supported filters.
", - "DescribeNetworkInsightsAnalysesRequest$Filters": "The filters. The following are possible values:
PathFound - 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 possible values:
Destination - The ID of the resource.
DestinationPort - The destination port.
Name - The path name.
Protocol - The protocol.
Source - The ID of the resource.
The filters. The following are the possible values:
PathFound - 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.
DestinationPort - The destination port.
Name - The path name.
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 Service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address 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.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your 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.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
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.
group-name - The name 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 | efa | 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-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
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 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.
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.
The state of the IPAM.
" } }, + "Ipv4PoolCoipId": { + "base": null, + "refs": { + "CoipPool$PoolId": "The ID of the address pool.
", + "CoipPoolIdSet$member": null, + "GetCoipPoolUsageRequest$PoolId": "The ID of the address pool.
" + } + }, "Ipv4PoolEc2Id": { "base": null, "refs": { @@ -16258,6 +16280,7 @@ "AddIpamOperatingRegion$RegionName": "The name of the operating Region.
", "AddPrefixListEntry$Cidr": "The CIDR block.
", "AddPrefixListEntry$Description": "A description for the entry.
Constraints: Up to 255 characters in length.
", + "AdditionalDetail$AdditionalDetailType": "The information type.
", "Address$InstanceId": "The ID of the instance that the address is associated with (if any).
", "Address$PublicIp": "The Elastic IP address.
", "Address$AllocationId": "The ID representing the allocation of the address for use with EC2-VPC.
", @@ -16306,11 +16329,11 @@ "AnalysisRouteTableRoute$InstanceId": "The ID of the instance, such as a NAT instance.
", "AnalysisRouteTableRoute$NatGatewayId": "The ID of a NAT gateway.
", "AnalysisRouteTableRoute$NetworkInterfaceId": "The ID of a network interface.
", - "AnalysisRouteTableRoute$Origin": "Describes how the route was created. The following are possible values:
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
Describes how the route was created. The following are the possible values:
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
The ID of a transit gateway.
", "AnalysisRouteTableRoute$VpcPeeringConnectionId": "The ID of a VPC peering connection.
", "AnalysisSecurityGroupRule$Cidr": "The IPv4 address range, in CIDR notation.
", - "AnalysisSecurityGroupRule$Direction": "The direction. The following are possible values:
egress
ingress
The direction. The following are the possible values:
egress
ingress
The security group ID.
", "AnalysisSecurityGroupRule$PrefixListId": "The prefix list ID.
", "AnalysisSecurityGroupRule$Protocol": "The protocol name.
", @@ -16907,7 +16930,7 @@ "EventInformation$EventSubType": "The event.
error events:
iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.
allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.
spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot Instances that you can launch.
spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.
fleetRequestChange events:
active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.
cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.
cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.
cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.
expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.
modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.
modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.
progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
instanceChange events:
launched - A new instance was launched.
terminated - An instance was terminated by the user.
termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.
Information events:
fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.
launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.
launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.
registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.
The ID of the instance. This information is available only for instanceChange events.
The direction. The following are possible values:
egress
ingress
The direction. The following are the possible values:
egress
ingress
The explanation code.
", "Explanation$MissingComponent": "The missing component.
", "Explanation$PacketField": "The packet field.
", @@ -17944,6 +17967,13 @@ "TransitGatewayRouteTableAssociation$ResourceId": "The ID of the resource.
", "TransitGatewayRouteTablePropagation$TransitGatewayAttachmentId": "The ID of the attachment.
", "TransitGatewayRouteTablePropagation$ResourceId": "The ID of the resource.
", + "TransitGatewayRouteTableRoute$DestinationCidr": "The CIDR block used for destination matches.
", + "TransitGatewayRouteTableRoute$State": "The state of the route.
", + "TransitGatewayRouteTableRoute$RouteOrigin": "The route origin. The following are the possible values:
static
propagated
The ID of the prefix list.
", + "TransitGatewayRouteTableRoute$AttachmentId": "The ID of the route attachment.
", + "TransitGatewayRouteTableRoute$ResourceId": "The ID of the resource for the route attachment.
", + "TransitGatewayRouteTableRoute$ResourceType": "The resource type for the route attachment.
", "TransitGatewayVpcAttachment$TransitGatewayAttachmentId": "The ID of the attachment.
", "TransitGatewayVpcAttachment$TransitGatewayId": "The ID of the transit gateway.
", "TransitGatewayVpcAttachment$VpcId": "The ID of the VPC.
", @@ -19394,6 +19424,13 @@ "GetTransitGatewayRouteTablePropagationsResult$TransitGatewayRouteTablePropagations": "Information about the route table propagations.
" } }, + "TransitGatewayRouteTableRoute": { + "base": "Describes a route in a transit gateway route table.
", + "refs": { + "Explanation$TransitGatewayRouteTableRoute": "The transit gateway route table route.
", + "PathComponent$TransitGatewayRouteTableRoute": "The route in a transit gateway route table.
" + } + }, "TransitGatewayRouteTableState": { "base": null, "refs": { diff --git a/models/apis/ssm/2014-11-06/api-2.json b/models/apis/ssm/2014-11-06/api-2.json index 109750e0e63..3037d975daf 100644 --- a/models/apis/ssm/2014-11-06/api-2.json +++ b/models/apis/ssm/2014-11-06/api-2.json @@ -7291,7 +7291,8 @@ "ORACLE_LINUX", "DEBIAN", "MACOS", - "RASPBIAN" + "RASPBIAN", + "ROCKY_LINUX" ] }, "OpsAggregator":{ diff --git a/models/apis/ssm/2014-11-06/docs-2.json b/models/apis/ssm/2014-11-06/docs-2.json index 55f63446239..84ab2b19f22 100644 --- a/models/apis/ssm/2014-11-06/docs-2.json +++ b/models/apis/ssm/2014-11-06/docs-2.json @@ -2,7 +2,7 @@ "version": "2.0", "service": "Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A managed node is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or virtual machine (VM) that has been configured for Systems Manager.
With support for IoT Greengrass core devices, the phrase managed instance has been changed to managed node in most of the Systems Manager documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the term instance.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
To get started, verify prerequisites and configure managed nodes. For more information, see Setting up Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.
Related resources
For information about how to use a Query API, see Making API requests.
For information about other API operations you can perform on EC2 instances, see the Amazon EC2 API Reference.
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference.
For information about Incident Manager, a capability of Systems Manager, see the Incident Manager User Guide and the Incident Manager API Reference.
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
Key=Owner,Value=DbAdmin
Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev
Key=Stack,Value=Production
Key=Stack,Value=Pre-Production
Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
", + "AddTagsToResource": "Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
Key=Owner,Value=DbAdmin
Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev
Key=Stack,Value=Production
Key=Stack,Value=Pre-Production
Key=Stack,Value=Test
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
", "AssociateOpsItemRelatedItem": "Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
", "CancelCommand": "Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
", "CancelMaintenanceWindowExecution": "Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.
", @@ -75,7 +75,7 @@ "GetMaintenanceWindowExecution": "Retrieves details about a specific a maintenance window execution.
", "GetMaintenanceWindowExecutionTask": "Retrieves the details about a specific task run as part of a maintenance window execution.
", "GetMaintenanceWindowExecutionTaskInvocation": "Retrieves information about a specific task running on a specific target.
", - "GetMaintenanceWindowTask": "Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.
Retrieves the details of a maintenance window task.
For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.
To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
", "GetOpsItem": "Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
", "GetOpsMetadata": "View operational metadata related to an application in Application Manager.
", "GetOpsSummary": "View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
", @@ -126,7 +126,7 @@ "UpdateAssociation": "Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.
In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter.
Updates one or more values for an SSM document.
", - "UpdateDocumentDefaultVersion": "Set the default version of a document.
", + "UpdateDocumentDefaultVersion": "Set the default version of a document.
If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.
Updates information related to approval reviews for a specific version of a change template in Change Manager.
", "UpdateMaintenanceWindow": "Updates an existing maintenance window. Only specified parameters are modified.
The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
Modifies the target of an existing maintenance window. You can change the following:
Name
Description
Owner
IDs for an ID target
Tags for a Tag target
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field isn't modified.
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
", "CreateAssociationBatchRequestEntry$ApplyOnlyAtCronInterval": "By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
", "CreateAssociationRequest$ApplyOnlyAtCronInterval": "By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
", - "UpdateAssociationRequest$ApplyOnlyAtCronInterval": "By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you edit that association or you make changes to the SSM document on which that association is based (by using the Documents page in the console), State Manager applies the association at the next specified cron interval. For example, if you chose the Latest version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously selected this option. If this option wasn't selected, State Manager immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.
The version of the document used in the association.
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.
The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.
The document version.
", "AssociationVersionInfo$DocumentVersion": "The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.
", "AutomationExecution$DocumentVersion": "The version of the document to use during execution.
", @@ -2517,7 +2517,7 @@ "StartChangeRequestExecutionRequest$DocumentVersion": "The version of the change template document to run during the runbook workflow.
", "UpdateAssociationRequest$DocumentVersion": "The document version you want update for the association.
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.
The version of a change template in which to update approval metadata.
", - "UpdateDocumentRequest$DocumentVersion": "The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.
The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.
If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
Automation: example-c160-4567-8519-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
ManagedInstance: mi-012345abcde
The ManagedInstance type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.
The resource ID you want to tag.
Use the ID of the resource. Here are some examples:
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
ManagedInstance: mi-012345abcde
The ManagedInstance type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.
The resource ID for which you want to see a list of tags.
", - "RemoveTagsFromResourceRequest$ResourceId": "The ID of the resource from which you want to remove tags. For example:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
Automation: example-c160-4567-8519-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
The ManagedInstance type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
The ID of the resource from which you want to remove tags. For example:
ManagedInstance: mi-012345abcde
MaintenanceWindow: mw-012345abcde
PatchBaseline: pb-012345abcde
OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.
For the Document and Parameter values, use the name of the resource.
The ManagedInstance type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
The tags, or metadata, that have been applied to the document.
", "ListTagsForResourceResult$TagList": "A list of tags.
", "PutParameterRequest$Tags": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:
Key=Resource,Value=S3bucket
Key=OS,Value=Windows
Key=ParameterType,Value=LicenseKey
To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing automation, use the AddTagsToResource operation.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource operation.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2