ec2_describe_fleets {aws.ecx}

Describe Fleets

Description

Describe Fleets

Usage

ec2_describe_fleets(
  DryRun = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  FleetId = NULL,
  Filter = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

MaxResults

Integer. The maximum number of results to return in a single call.[optional]

NextToken

Characters. The token for the next page of results[optional]

FleetId

List. The ID of the EC2 Fleets.[optional]

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

DryRun

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.

MaxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

FleetId

The ID of the EC2 Fleets.

Filter

The filters.

• activity-status - The progress of the EC2 Fleet ( error \| pending-fulfillment \| pending-termination \| fulfilled).

• excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true \| false).

• fleet-state - The state of the EC2 Fleet (submitted \| active \| deleted \| failed \| deleted-running \| deleted-terminating \| modifying).

• replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true \| false).

• type - The type of request (instant \| request \| maintain).