Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeS3AccessPointAttachments

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

The requester requires the following permission to perform this action:

fsx:DescribeS3AccessPointAttachments

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "Names": [ "string" ],
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

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

Type: Array of S3AccessPointAttachmentsFilter objects

Array Members: Maximum number of 2 items.

Required: No

MaxResults

The maximum number of resources to return in the response. This value must be an integer greater than zero.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 2147483647.

Required: No

Names

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

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Minimum length of 3. Maximum length of 50.

Pattern: ^(?=[a-z0-9])[a-z0-9-]{1,48}[a-z0-9]$

Required: No

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$

Required: No

Response Syntax


{
   "NextToken": "string",
   "S3AccessPointAttachments": [ 
      { 
         "CreationTime": number,
         "Lifecycle": "string",
         "LifecycleTransitionReason": { 
            "Message": "string"
         },
         "Name": "string",
         "OpenZFSConfiguration": { 
            "FileSystemIdentity": { 
               "PosixUser": { 
                  "Gid": number,
                  "SecondaryGids": [ number ],
                  "Uid": number
               },
               "Type": "string"
            },
            "VolumeId": "string"
         },
         "S3AccessPoint": { 
            "Alias": "string",
            "ResourceARN": "string",
            "VpcConfiguration": { 
               "VpcId": "string"
            }
         },
         "Type": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$

S3AccessPointAttachments

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

Type: Array of S3AccessPointAttachment objects

Array Members: Maximum number of 1000 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

S3AccessPointAttachmentNotFound

The access point specified was not found.

HTTP Status Code: 400

UnsupportedOperation

The requested operation is not supported for this resource or API.

HTTP Status Code: 400