[ aws . worklink ]

describe-fleet-metadata

Description

Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-fleet-metadata
--fleet-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--fleet-arn (string)

The Amazon Resource Name (ARN) of the fleet.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

CreatedTime -> (timestamp)

The time that the fleet was created.

LastUpdatedTime -> (timestamp)

The time that the fleet was last updated.

FleetName -> (string)

The name of the fleet.

DisplayName -> (string)

The name to display.

OptimizeForEndUserLocation -> (boolean)

The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

CompanyCode -> (string)

The identifier used by users to sign in to the Amazon WorkLink app.

FleetStatus -> (string)

The current state of the fleet.

Tags -> (map)

The tags attached to the resource. A tag is a key-value pair.

key -> (string)

value -> (string)