AWS CLI Command Reference

[ aws . fsx ]

describe-s3-access-point-attachments

Description

Describes one or more S3 access points attached to Amazon FSx volumes.

The requester requires the following permission to perform this action:

  • fsx:DescribeS3AccessPointAttachments

See also: AWS API Documentation

describe-s3-access-point-attachments 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: S3AccessPointAttachments

Synopsis

  describe-s3-access-point-attachments
[--names <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--names (list)

The names of the S3 access point attachments whose descriptions you want to retrieve.

(string)

Syntax:

"string" "string" ...

--filters (list)

Enter a filter Name and Values pair to view a select set of S3 access point attachments.

(structure)

A set of Name and Values pairs used to view a select set of S3 access point attachments.

Name -> (string)

The name of the filter.

Values -> (list)

The values of the filter.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "file-system-id"|"volume-id"|"type",
    "Values": ["string", ...]
  }
  ...
]

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

--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 the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken 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. 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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

S3AccessPointAttachments -> (list)

Array of S3 access point attachments returned after a successful DescribeS3AccessPointAttachments operation.

(structure)

An S3 access point attached to an Amazon FSx volume.

Lifecycle -> (string)

The lifecycle status of the S3 access point attachment. The lifecycle can have the following values:

  • AVAILABLE - the S3 access point attachment is available for use
  • CREATING - Amazon FSx is creating the S3 access point and attachment
  • DELETING - Amazon FSx is deleting the S3 access point and attachment
  • FAILED - The S3 access point attachment is in a failed state. Delete and detach the S3 access point attachment, and create a new one.
  • UPDATING - Amazon FSx is updating the S3 access point attachment

LifecycleTransitionReason -> (structure)

Describes why a resource lifecycle state changed.

Message -> (string)

A detailed error message.

CreationTime -> (timestamp)

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

Name -> (string)

The name of the S3 access point attachment; also used for the name of the S3 access point.

Type -> (string)

The type of Amazon FSx volume that the S3 access point is attached to.

OpenZFSConfiguration -> (structure)

The OpenZFSConfiguration of the S3 access point attachment.

VolumeId -> (string)

The ID of the FSx for OpenZFS volume that the S3 access point is attached to.

FileSystemIdentity -> (structure)

The file system identity used to authorize file access requests made using the S3 access point.

Type -> (string)

Specifies the FSx for OpenZFS user identity type, accepts only POSIX .

PosixUser -> (structure)

Specifies the UID and GIDs of the file system POSIX user.

Uid -> (long)

The UID of the file system user.

Gid -> (long)

The GID of the file system user.

SecondaryGids -> (list)

The list of secondary GIDs for the file system user.

(long)

S3AccessPoint -> (structure)

The S3 access point configuration of the S3 access point attachment.

ResourceARN -> (string)

he S3 access point’s ARN.

Alias -> (string)

The S3 access point’s alias.

VpcConfiguration -> (structure)

The S3 access point’s virtual private cloud (VPC) configuration.

VpcId -> (string)

Specifies the virtual private cloud (VPC) for the S3 access point VPC configuration, if one exists.

NextToken -> (string)

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.
© Copyright 2025, Amazon Web Services. Created using Sphinx.