Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . s3files ]

get-file-system

Description

Returns resource information for the specified S3 File System including status, configuration, and metadata.

See also: AWS API Documentation

Synopsis

  get-file-system
--file-system-id <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>]
[--v2-debug]

Options

--file-system-id (string)

The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve information for.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

creationTime -> (timestamp)

The time when the file system was created.

fileSystemArn -> (string)

The Amazon Resource Name (ARN) of the file system.

fileSystemId -> (string)

The ID of the file system.

bucket -> (string)

The Amazon Resource Name (ARN) of the S3 bucket.

prefix -> (string)

The prefix in the S3 bucket that the file system provides access to.

clientToken -> (string)

The client token used for idempotency when the file system was created.

kmsKeyId -> (string)

The Amazon Resource Name (ARN) of the Amazon Web Services KMS key used for encryption.

status -> (string)

The current status of the file system.

statusMessage -> (string)

Additional information about the file system status.

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role used for S3 access.

ownerId -> (string)

The Amazon Web Services account ID of the file system owner.

tags -> (list)

The tags associated with the file system.

(structure)

A key-value pair for resource tagging.

key -> (string)

The tag key. The key can’t start with aws: .

value -> (string)

The tag value.

name -> (string)

The name of the file system.