AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

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.

[ aws . datasync ]

describe-agent

Description

Returns information about an DataSync agent, such as its name, service endpoint type, and status.

See also: AWS API Documentation

Synopsis

  describe-agent
--agent-arn <value>
[--cli-input-json <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>]

Options

--agent-arn (string)

Specifies the Amazon Resource Name (ARN) of the DataSync agent that you want information about.

--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.

--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.

Global Options

--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.

  • json
  • text
  • table

--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.

  • on
  • off
  • auto

--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.

Output

AgentArn -> (string)

The ARN of the agent.

Name -> (string)

The name of the agent.

Status -> (string)

The status of the agent.

  • If the status is ONLINE , the agent is configured properly and ready to use.
  • If the status is OFFLINE , the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?

LastConnectionTime -> (timestamp)

The last time that the agent was communicating with the DataSync service.

CreationTime -> (timestamp)

The time that the agent was activated .

EndpointType -> (string)

The type of service endpoint that your agent is connected to.

PrivateLinkConfig -> (structure)

The network configuration that the agent uses when connecting to a VPC service endpoint .

VpcEndpointId -> (string)

Specifies the ID of the VPC endpoint that your agent connects to.

PrivateLinkEndpoint -> (string)

Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.

SubnetArns -> (list)

Specifies the ARN of the subnet where your VPC endpoint is located. You can only specify one ARN.

(string)

SecurityGroupArns -> (list)

Specifies the Amazon Resource Names (ARN) of the security group that provides DataSync access to your VPC endpoint. You can only specify one ARN.

(string)

Platform -> (structure)

The platform-related details about the agent, such as the version number.

Version -> (string)

The version of the DataSync agent.