AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Lists workers.
See also: AWS API Documentation
list-workers
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: workers
list-workers
--farm-id <value>
--fleet-id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--farm-id
(string)
The farm ID connected to the workers.
--fleet-id
(string)
The fleet ID of the workers.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command's output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
nextToken -> (string)
If Deadline Cloud returnsnextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
workers -> (list)
The workers on the list.
(structure)
The summary of details for a worker.
workerId -> (string)
The worker ID.farmId -> (string)
The farm ID.fleetId -> (string)
The fleet ID.status -> (string)
The status of the worker.hostProperties -> (structure)
The host properties of the worker.
ipAddresses -> (structure)
The IP address of the host.
ipV4Addresses -> (list)
The IpV4 address of the network.
(string)
ipV6Addresses -> (list)
The IpV6 address for the network and node component.
(string)
hostName -> (string)
The host name.ec2InstanceArn -> (string)
The ARN of the host EC2 instance.ec2InstanceType -> (string)
The instance type of the host EC2 instance.log -> (structure)
The log configuration for the worker.
logDriver -> (string)
The log drivers for worker related logs.options -> (map)
The options for a log driver.
key -> (string)
value -> (string)
parameters -> (map)
The parameters for the log configuration.
key -> (string)
value -> (string)
error -> (string)
The log configuration error details.createdAt -> (timestamp)
The date and time the resource was created.createdBy -> (string)
The user or system that created this resource.updatedAt -> (timestamp)
The date and time the resource was updated.updatedBy -> (string)
The user or system that updated this resource.