Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateAndAttachS3AccessPoint

Creates an S3 access point and attaches it to an Amazon FSx volume. For FSx for OpenZFS file systems, the volume must be hosted on a high-availability file system, either Single-AZ or Multi-AZ. For more information, see Accessing your data using Amazon S3 access points. in the Amazon FSx for OpenZFS User Guide.

The requester requires the following permissions to perform these actions:

fsx:CreateAndAttachS3AccessPoint
s3:CreateAccessPoint
s3:GetAccessPoint
s3:PutAccessPointPolicy
s3:DeleteAccessPoint

The following actions are related to CreateAndAttachS3AccessPoint:

Request Syntax


{
   "ClientRequestToken": "string",
   "Name": "string",
   "OpenZFSConfiguration": { 
      "FileSystemIdentity": { 
         "PosixUser": { 
            "Gid": number,
            "SecondaryGids": [ number ],
            "Uid": number
         },
         "Type": "string"
      },
      "VolumeId": "string"
   },
   "S3AccessPoint": { 
      "Policy": "string",
      "VpcConfiguration": { 
         "VpcId": "string"
      }
   },
   "Type": "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.

ClientRequestToken

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Amazon Command Line Interface (Amazon CLI) or an Amazon SDK.

Type: String

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

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

Name

The name you want to assign to this S3 access point.

Type: String

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

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

Required: Yes

OpenZFSConfiguration

Specifies the configuration to use when creating and attaching an S3 access point to an FSx for OpenZFS volume.

Type: CreateAndAttachS3AccessPointOpenZFSConfiguration object

Required: No

S3AccessPoint

Specifies the virtual private cloud (VPC) configuration if you're creating an access point that is restricted to a VPC. For more information, see Creating access points restricted to a virtual private cloud.

Type: CreateAndAttachS3AccessPointS3Configuration object

Required: No

Type

The type of S3 access point you want to create. Only OpenZFS is supported.

Type: String

Valid Values: OPENZFS

Required: Yes

Response Syntax


{
   "S3AccessPointAttachment": { 
      "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.

S3AccessPointAttachment

Describes the configuration of the S3 access point created.

Type: S3AccessPointAttachment object

Errors

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

AccessPointAlreadyOwnedByYou

An access point with that name already exists in the Amazon Web Services Region in your Amazon Web Services account.

ErrorCode: An error code indicating that an access point with that name already exists in the Amazon Web Services Region in your Amazon Web Services account.
Message: A detailed error message.

HTTP Status Code: 400

BadRequest

A generic error indicating a failure with a client request.

Message: A detailed error message.

HTTP Status Code: 400

IncompatibleParameterError

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

Message: A detailed error message.
Parameter: A parameter that is incompatible with the earlier request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

Message: A detailed error message.

HTTP Status Code: 500

InvalidAccessPoint

The access point specified doesn't exist.

ErrorCode: An error code indicating that the access point specified doesn't exist.
Message: A detailed error message.

HTTP Status Code: 400

InvalidRequest

The action or operation requested is invalid. Verify that the action is typed correctly.

ErrorCode: An error code indicating that the action or operation requested is invalid.
Message: A detailed error message.

HTTP Status Code: 400

TooManyAccessPoints

You have reached the maximum number of S3 access points attachments allowed for your account in this Amazon Web Services Region, or for the file system. For more information, or to request an increase, see Service quotas on FSx resources in the FSx for OpenZFS User Guide.

ErrorCode: An error code indicating that you have reached the maximum number of S3 access points attachments allowed for your account in this Amazon Web Services Region, or for the file system.
Message: A detailed error message.

HTTP Status Code: 400

UnsupportedOperation

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

Message: A detailed error message.

HTTP Status Code: 400

VolumeNotFound

No Amazon FSx volumes were found based upon the supplied parameters.

Message: A detailed error message.

HTTP Status Code: 400