SDK for PHP V3

Amazon S3 Files 2025-05-05

Client: Aws\S3Files\S3FilesClient
Service ID: s3files
Version: 2025-05-05

This page describes the parameters and results for the operations of the Amazon S3 Files (2025-05-05), and shows how to use the Aws\S3Files\S3FilesClient object to call the described operations. This documentation is specific to the 2025-05-05 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateAccessPoint ( array $params = [] )
Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement.
CreateFileSystem ( array $params = [] )
Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data.
CreateMountTarget ( array $params = [] )
Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC.
DeleteAccessPoint ( array $params = [] )
Deletes an S3 File System Access Point.
DeleteFileSystem ( array $params = [] )
Deletes an S3 File System.
DeleteFileSystemPolicy ( array $params = [] )
Deletes the IAM resource policy of an S3 File System.
DeleteMountTarget ( array $params = [] )
Deletes the specified mount target.
GetAccessPoint ( array $params = [] )
Returns resource information for an S3 File System Access Point.
GetFileSystem ( array $params = [] )
Returns resource information for the specified S3 File System including status, configuration, and metadata.
GetFileSystemPolicy ( array $params = [] )
Returns the IAM resource policy of an S3 File System.
GetMountTarget ( array $params = [] )
Returns detailed resource information for the specified mount target including network configuration.
GetSynchronizationConfiguration ( array $params = [] )
Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.
ListAccessPoints ( array $params = [] )
Returns resource information for all S3 File System Access Points associated with the specified S3 File System.
ListFileSystems ( array $params = [] )
Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.
ListMountTargets ( array $params = [] )
Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.
ListTagsForResource ( array $params = [] )
Lists all tags for S3 Files resources.
PutFileSystemPolicy ( array $params = [] )
Creates or replaces the IAM resource policy for an S3 File System to control access permissions.
PutSynchronizationConfiguration ( array $params = [] )
Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.
TagResource ( array $params = [] )
Creates tags for S3 Files resources using standard Amazon Web Services tagging APIs.
UntagResource ( array $params = [] )
Removes tags from S3 Files resources.
UpdateMountTarget ( array $params = [] )
Updates the mount target resource, specifically security group configurations.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAccessPoints
ListFileSystems
ListMountTargets
ListTagsForResource

Operations

CreateAccessPoint 

$result = $client->createAccessPoint([/* ... */]);
$promise = $client->createAccessPointAsync([/* ... */]);

Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement. Access points provide a way to manage access to shared datasets in multi-tenant scenarios.

Parameter Syntax

$result = $client->createAccessPoint([
    'clientToken' => '<string>',
    'fileSystemId' => '<string>', // REQUIRED
    'posixUser' => [
        'gid' => <integer>, // REQUIRED
        'secondaryGids' => [<integer>, ...],
        'uid' => <integer>, // REQUIRED
    ],
    'rootDirectory' => [
        'creationPermissions' => [
            'ownerGid' => <integer>, // REQUIRED
            'ownerUid' => <integer>, // REQUIRED
            'permissions' => '<string>', // REQUIRED
        ],
        'path' => '<string>',
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
clientToken
Type: string

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Web Services ignores the request, but does not return an error.

fileSystemId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the S3 File System.

posixUser
Type: PosixUser structure

The POSIX identity with uid, gid, and secondary group IDs for user enforcement when accessing the file system through this access point.

rootDirectory
Type: RootDirectory structure

The root directory path for the access point, with optional creation permissions for newly created directories.

tags
Type: Array of Tag structures

An array of key-value pairs to apply to the access point for resource tagging.

Result Syntax

[
    'accessPointArn' => '<string>',
    'accessPointId' => '<string>',
    'clientToken' => '<string>',
    'fileSystemId' => '<string>',
    'name' => '<string>',
    'ownerId' => '<string>',
    'posixUser' => [
        'gid' => <integer>,
        'secondaryGids' => [<integer>, ...],
        'uid' => <integer>,
    ],
    'rootDirectory' => [
        'creationPermissions' => [
            'ownerGid' => <integer>,
            'ownerUid' => <integer>,
            'permissions' => '<string>',
        ],
        'path' => '<string>',
    ],
    'status' => 'available|creating|deleting|deleted|error|updating',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
accessPointArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the access point.

accessPointId
Required: Yes
Type: string

The ID of the access point.

clientToken
Required: Yes
Type: string

The client token that was provided in the request.

fileSystemId
Required: Yes
Type: string

The ID of the S3 File System.

name
Type: string

The name of the access point.

ownerId
Required: Yes
Type: string

The Amazon Web Services account ID of the access point owner.

posixUser
Type: PosixUser structure

The POSIX identity configured for this access point.

rootDirectory
Type: RootDirectory structure

The root directory configuration for this access point.

status
Required: Yes
Type: string

The current status of the access point.

tags
Type: Array of Tag structures

The tags associated with the access point.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ServiceQuotaExceededException:

The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ConflictException:

The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.

CreateFileSystem 

$result = $client->createFileSystem([/* ... */]);
$promise = $client->createFileSystemAsync([/* ... */]);

Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data. To create a file system, you need an S3 bucket and an IAM role that grants the service permission to access the bucket.

Parameter Syntax

$result = $client->createFileSystem([
    'acceptBucketWarning' => true || false,
    'bucket' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'kmsKeyId' => '<string>',
    'prefix' => '<string>',
    'roleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
acceptBucketWarning
Type: boolean

Set to true to acknowledge and accept any warnings about the bucket configuration. If not specified, the operation may fail if there are bucket configuration warnings.

bucket
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system. The bucket must exist and be in the same Amazon Web Services Region as the file system.

clientToken
Type: string

A unique, case-sensitive identifier that you provide to ensure idempotent creation. Up to 64 ASCII characters are allowed. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

kmsKeyId
Type: string

The ARN, key ID, or alias of the KMS key to use for encryption. If not specified, the service uses a service-owned key for encryption. You can specify a KMS key using the following formats: key ID, ARN, key alias, or key alias ARN. If you use KmsKeyId, the file system will be encrypted.

prefix
Type: string

An optional prefix within the S3 bucket to scope the file system access. If specified, the file system provides access only to objects with keys that begin with this prefix. If not specified, the file system provides access to the entire bucket.

roleArn
Required: Yes
Type: string

The ARN of the IAM role that grants the S3 Files service permission to read and write data between the file system and the S3 bucket. This role must have the necessary permissions to access the specified bucket and prefix.

tags
Type: Array of Tag structures

An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.

Result Syntax

[
    'bucket' => '<string>',
    'clientToken' => '<string>',
    'creationTime' => <DateTime>,
    'fileSystemArn' => '<string>',
    'fileSystemId' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>',
    'ownerId' => '<string>',
    'prefix' => '<string>',
    'roleArn' => '<string>',
    'status' => 'available|creating|deleting|deleted|error|updating',
    'statusMessage' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
bucket
Type: string

The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.

clientToken
Type: string

The client token used for idempotency.

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).

fileSystemArn
Type: string

The ARN for the S3 file system, in the format arn:aws:s3files:region:account-id:file-system/file-system-id.

fileSystemId
Type: string

The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls.

kmsKeyId
Type: string

The ARN or alias of the KMS key used for encryption.

name
Type: string

The name of the file system, derived from the Name tag if present.

ownerId
Type: string

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

prefix
Type: string

The prefix within the S3 bucket that scopes the file system access.

roleArn
Type: string

The ARN of the IAM role used for S3 access.

status
Type: string

The lifecycle state of the file system. Valid values are: AVAILABLE (the file system is available for use), CREATING (the file system is being created), DELETING (the file system is being deleted), DELETED (the file system has been deleted), ERROR (the file system is in an error state), or UPDATING (the file system is being updated).

statusMessage
Type: string

Additional information about the file system status. This field provides more details when the status is ERROR, or during state transitions.

tags
Type: Array of Tag structures

The tags associated with the file system.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ServiceQuotaExceededException:

The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ConflictException:

The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.

CreateMountTarget 

$result = $client->createMountTarget([/* ... */]);
$promise = $client->createMountTargetAsync([/* ... */]);

Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC. Mount targets provide network access to the file system.

Parameter Syntax

$result = $client->createMountTarget([
    'fileSystemId' => '<string>', // REQUIRED
    'ipAddressType' => 'IPV4_ONLY|IPV6_ONLY|DUAL_STACK',
    'ipv4Address' => '<string>',
    'ipv6Address' => '<string>',
    'securityGroups' => ['<string>', ...],
    'subnetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
fileSystemId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the S3 File System to create the mount target for.

ipAddressType
Type: string

The IP address type for the mount target. If not specified, IPV4_ONLY is used. The IP address type must match the IP configuration of the specified subnet.

ipv4Address
Type: string

A specific IPv4 address to assign to the mount target. If not specified and the IP address type supports IPv4, an address is automatically assigned from the subnet's available IPv4 address range. The address must be within the subnet's CIDR block and not already in use.

ipv6Address
Type: string

A specific IPv6 address to assign to the mount target. If not specified and the IP address type supports IPv6, an address is automatically assigned from the subnet's available IPv6 address range. The address must be within the subnet's IPv6 CIDR block and not already in use.

securityGroups
Type: Array of strings

An array of VPC security group IDs to associate with the mount target's network interface. These security groups control network access to the mount target. If not specified, the default security group for the subnet's VPC is used. All security groups must belong to the same VPC as the subnet.

subnetId
Required: Yes
Type: string

The ID of the subnet where the mount target will be created. The subnet must be in the same Amazon Web Services Region as the file system. For file systems with regional availability, you can create mount targets in any subnet within the Region. The subnet determines the Availability Zone where the mount target will be located.

Result Syntax

[
    'availabilityZoneId' => '<string>',
    'fileSystemId' => '<string>',
    'ipv4Address' => '<string>',
    'ipv6Address' => '<string>',
    'mountTargetId' => '<string>',
    'networkInterfaceId' => '<string>',
    'ownerId' => '<string>',
    'securityGroups' => ['<string>', ...],
    'status' => 'available|creating|deleting|deleted|error|updating',
    'statusMessage' => '<string>',
    'subnetId' => '<string>',
    'vpcId' => '<string>',
]

Result Details

Members
availabilityZoneId
Type: string

The unique and consistent identifier of the Availability Zone where the mount target is located. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

fileSystemId
Type: string

The ID of the S3 File System associated with the mount target.

ipv4Address
Type: string

The IPv4 address assigned to the mount target.

ipv6Address
Type: string

The IPv6 address assigned to the mount target.

mountTargetId
Required: Yes
Type: string

The ID of the mount target, assigned by S3 Files. This ID is used to reference the mount target in subsequent API calls.

networkInterfaceId
Type: string

The ID of the network interface that S3 Files created when it created the mount target. This network interface is managed by the service.

ownerId
Required: Yes
Type: string

The Amazon Web Services account ID of the mount target owner.

securityGroups
Type: Array of strings

The security groups associated with the mount target's network interface.

status
Type: string

The lifecycle state of the mount target. Valid values are: AVAILABLE (the mount target is available for use), CREATING (the mount target is being created), DELETING (the mount target is being deleted), DELETED (the mount target has been deleted), or ERROR (the mount target is in an error state), or UPDATING (the mount target is being updated).

statusMessage
Type: string

Additional information about the mount target status. This field provides more details when the status is ERROR, or during state transitions.

subnetId
Required: Yes
Type: string

The ID of the subnet where the mount target is located.

vpcId
Type: string

The ID of the VPC where the mount target is located.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ServiceQuotaExceededException:

The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ConflictException:

The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.

DeleteAccessPoint 

$result = $client->deleteAccessPoint([/* ... */]);
$promise = $client->deleteAccessPointAsync([/* ... */]);

Deletes an S3 File System Access Point. This operation is irreversible.

Parameter Syntax

$result = $client->deleteAccessPoint([
    'accessPointId' => '<string>', // REQUIRED
]);

Parameter Details

Members
accessPointId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the access point to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ConflictException:

The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.

DeleteFileSystem 

$result = $client->deleteFileSystem([/* ... */]);
$promise = $client->deleteFileSystemAsync([/* ... */]);

Deletes an S3 File System. You can optionally force deletion of a file system that has pending export data.

Parameter Syntax

$result = $client->deleteFileSystem([
    'fileSystemId' => '<string>', // REQUIRED
    'forceDelete' => true || false,
]);

Parameter Details

Members
fileSystemId
Required: Yes
Type: string

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

forceDelete
Type: boolean

If true, allows deletion of a file system that contains data pending export to S3. If false (the default), the deletion will fail if there is data that has not yet been exported to the S3 bucket. Use this parameter with caution as it may result in data loss.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ConflictException:

The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.

DeleteFileSystemPolicy 

$result = $client->deleteFileSystemPolicy([/* ... */]);
$promise = $client->deleteFileSystemPolicyAsync([/* ... */]);

Deletes the IAM resource policy of an S3 File System.

Parameter Syntax

$result = $client->deleteFileSystemPolicy([
    'fileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

Members
fileSystemId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the S3 File System whose resource policy to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

DeleteMountTarget 

$result = $client->deleteMountTarget([/* ... */]);
$promise = $client->deleteMountTargetAsync([/* ... */]);

Deletes the specified mount target. This operation is irreversible.

Parameter Syntax

$result = $client->deleteMountTarget([
    'mountTargetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
mountTargetId
Required: Yes
Type: string

The ID of the mount target to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ConflictException:

The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.

GetAccessPoint 

$result = $client->getAccessPoint([/* ... */]);
$promise = $client->getAccessPointAsync([/* ... */]);

Returns resource information for an S3 File System Access Point.

Parameter Syntax

$result = $client->getAccessPoint([
    'accessPointId' => '<string>', // REQUIRED
]);

Parameter Details

Members
accessPointId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the access point to retrieve information for.

Result Syntax

[
    'accessPointArn' => '<string>',
    'accessPointId' => '<string>',
    'clientToken' => '<string>',
    'fileSystemId' => '<string>',
    'name' => '<string>',
    'ownerId' => '<string>',
    'posixUser' => [
        'gid' => <integer>,
        'secondaryGids' => [<integer>, ...],
        'uid' => <integer>,
    ],
    'rootDirectory' => [
        'creationPermissions' => [
            'ownerGid' => <integer>,
            'ownerUid' => <integer>,
            'permissions' => '<string>',
        ],
        'path' => '<string>',
    ],
    'status' => 'available|creating|deleting|deleted|error|updating',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
accessPointArn
Required: Yes
Type: string

The ARN of the access point.

accessPointId
Required: Yes
Type: string

The ID of the access point.

clientToken
Required: Yes
Type: string

The client token used for idempotency when the access point was created.

fileSystemId
Required: Yes
Type: string

The ID of the S3 File System.

name
Type: string

The name of the access point.

ownerId
Required: Yes
Type: string

The Amazon Web Services account ID of the access point owner.

posixUser
Type: PosixUser structure

The POSIX identity configured for this access point.

rootDirectory
Type: RootDirectory structure

The root directory configuration for this access point.

status
Required: Yes
Type: string

The current status of the access point.

tags
Type: Array of Tag structures

The tags associated with the access point.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

GetFileSystem 

$result = $client->getFileSystem([/* ... */]);
$promise = $client->getFileSystemAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getFileSystem([
    'fileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

Members
fileSystemId
Required: Yes
Type: string

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

Result Syntax

[
    'bucket' => '<string>',
    'clientToken' => '<string>',
    'creationTime' => <DateTime>,
    'fileSystemArn' => '<string>',
    'fileSystemId' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>',
    'ownerId' => '<string>',
    'prefix' => '<string>',
    'roleArn' => '<string>',
    'status' => 'available|creating|deleting|deleted|error|updating',
    'statusMessage' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
bucket
Type: string

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

clientToken
Type: string

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

creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the file system was created.

fileSystemArn
Type: string

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

fileSystemId
Type: string

The ID of the file system.

kmsKeyId
Type: string

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

name
Type: string

The name of the file system.

ownerId
Type: string

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

prefix
Type: string

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

roleArn
Type: string

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

status
Type: string

The current status of the file system.

statusMessage
Type: string

Additional information about the file system status.

tags
Type: Array of Tag structures

The tags associated with the file system.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

GetFileSystemPolicy 

$result = $client->getFileSystemPolicy([/* ... */]);
$promise = $client->getFileSystemPolicyAsync([/* ... */]);

Returns the IAM resource policy of an S3 File System.

Parameter Syntax

$result = $client->getFileSystemPolicy([
    'fileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

Members
fileSystemId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the S3 File System whose resource policy to retrieve.

Result Syntax

[
    'fileSystemId' => '<string>',
    'policy' => '<string>',
]

Result Details

Members
fileSystemId
Required: Yes
Type: string

The ID of the file system.

policy
Required: Yes
Type: string

The JSON-formatted resource policy for the file system.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

GetMountTarget 

$result = $client->getMountTarget([/* ... */]);
$promise = $client->getMountTargetAsync([/* ... */]);

Returns detailed resource information for the specified mount target including network configuration.

Parameter Syntax

$result = $client->getMountTarget([
    'mountTargetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
mountTargetId
Required: Yes
Type: string

The ID of the mount target to retrieve information for.

Result Syntax

[
    'availabilityZoneId' => '<string>',
    'fileSystemId' => '<string>',
    'ipv4Address' => '<string>',
    'ipv6Address' => '<string>',
    'mountTargetId' => '<string>',
    'networkInterfaceId' => '<string>',
    'ownerId' => '<string>',
    'securityGroups' => ['<string>', ...],
    'status' => 'available|creating|deleting|deleted|error|updating',
    'statusMessage' => '<string>',
    'subnetId' => '<string>',
    'vpcId' => '<string>',
]

Result Details

Members
availabilityZoneId
Type: string

The Availability Zone ID where the mount target is located.

fileSystemId
Type: string

The ID of the file system.

ipv4Address
Type: string

The IPv4 address of the mount target.

ipv6Address
Type: string

The IPv6 address of the mount target.

mountTargetId
Required: Yes
Type: string

The ID of the mount target.

networkInterfaceId
Type: string

The ID of the network interface associated with the mount target.

ownerId
Required: Yes
Type: string

The Amazon Web Services account ID of the mount target owner.

securityGroups
Type: Array of strings

The security groups associated with the mount target.

status
Type: string

The current status of the mount target.

statusMessage
Type: string

Additional information about the mount target status.

subnetId
Required: Yes
Type: string

The ID of the subnet where the mount target is located.

vpcId
Type: string

The ID of the VPC where the mount target is located.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

GetSynchronizationConfiguration 

$result = $client->getSynchronizationConfiguration([/* ... */]);
$promise = $client->getSynchronizationConfigurationAsync([/* ... */]);

Returns the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

Parameter Syntax

$result = $client->getSynchronizationConfiguration([
    'fileSystemId' => '<string>', // REQUIRED
]);

Parameter Details

Members
fileSystemId
Required: Yes
Type: string

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

Result Syntax

[
    'expirationDataRules' => [
        [
            'daysAfterLastAccess' => <integer>,
        ],
        // ...
    ],
    'importDataRules' => [
        [
            'prefix' => '<string>',
            'sizeLessThan' => <integer>,
            'trigger' => 'ON_DIRECTORY_FIRST_ACCESS|ON_FILE_ACCESS',
        ],
        // ...
    ],
    'latestVersionNumber' => <integer>,
]

Result Details

Members
expirationDataRules
Required: Yes
Type: Array of ExpirationDataRule structures

An array of expiration data rules that control when cached data expires from the file system.

importDataRules
Required: Yes
Type: Array of ImportDataRule structures

An array of import data rules that control how data is imported from S3 into the file system.

latestVersionNumber
Type: int

The version number of the synchronization configuration. Use this value with PutSynchronizationConfiguration to ensure optimistic concurrency control.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ListAccessPoints 

$result = $client->listAccessPoints([/* ... */]);
$promise = $client->listAccessPointsAsync([/* ... */]);

Returns resource information for all S3 File System Access Points associated with the specified S3 File System.

Parameter Syntax

$result = $client->listAccessPoints([
    'fileSystemId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
fileSystemId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the S3 File System to list access points for.

maxResults
Type: int

The maximum number of access points to return in a single response.

nextToken
Type: string

A pagination token returned from a previous call to continue listing access points.

Result Syntax

[
    'accessPoints' => [
        [
            'accessPointArn' => '<string>',
            'accessPointId' => '<string>',
            'fileSystemId' => '<string>',
            'name' => '<string>',
            'ownerId' => '<string>',
            'posixUser' => [
                'gid' => <integer>,
                'secondaryGids' => [<integer>, ...],
                'uid' => <integer>,
            ],
            'rootDirectory' => [
                'creationPermissions' => [
                    'ownerGid' => <integer>,
                    'ownerUid' => <integer>,
                    'permissions' => '<string>',
                ],
                'path' => '<string>',
            ],
            'status' => 'available|creating|deleting|deleted|error|updating',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
accessPoints
Required: Yes
Type: Array of ListAccessPointsDescription structures

An array of access point descriptions.

nextToken
Type: string

A pagination token to use in a subsequent request if more results are available.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ListFileSystems 

$result = $client->listFileSystems([/* ... */]);
$promise = $client->listFileSystemsAsync([/* ... */]);

Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.

Parameter Syntax

$result = $client->listFileSystems([
    'bucket' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
bucket
Type: string

Optional filter to list only file systems associated with the specified S3 bucket Amazon Resource Name (ARN). If provided, only file systems that provide access to this bucket will be returned in the response.

maxResults
Type: int

The maximum number of file systems to return in a single response. If not specified, up to 100 file systems are returned.

nextToken
Type: string

A pagination token returned from a previous call to continue listing file systems.

Result Syntax

[
    'fileSystems' => [
        [
            'bucket' => '<string>',
            'creationTime' => <DateTime>,
            'fileSystemArn' => '<string>',
            'fileSystemId' => '<string>',
            'name' => '<string>',
            'ownerId' => '<string>',
            'roleArn' => '<string>',
            'status' => 'available|creating|deleting|deleted|error|updating',
            'statusMessage' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
fileSystems
Required: Yes
Type: Array of ListFileSystemsDescription structures

An array of file system descriptions.

nextToken
Type: string

A pagination token to use in a subsequent request if more results are available.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ListMountTargets 

$result = $client->listMountTargets([/* ... */]);
$promise = $client->listMountTargetsAsync([/* ... */]);

Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.

Parameter Syntax

$result = $client->listMountTargets([
    'accessPointId' => '<string>',
    'fileSystemId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
accessPointId
Type: string

Optional filter to list only mount targets associated with the specified access point ID or Amazon Resource Name (ARN).

fileSystemId
Type: string

Optional filter to list only mount targets associated with the specified S3 File System ID or Amazon Resource Name (ARN). If provided, only mount targets for this file system will be returned in the response.

maxResults
Type: int

The maximum number of mount targets to return in a single response.

nextToken
Type: string

A pagination token returned from a previous call to continue listing mount targets.

Result Syntax

[
    'mountTargets' => [
        [
            'availabilityZoneId' => '<string>',
            'fileSystemId' => '<string>',
            'ipv4Address' => '<string>',
            'ipv6Address' => '<string>',
            'mountTargetId' => '<string>',
            'networkInterfaceId' => '<string>',
            'ownerId' => '<string>',
            'status' => 'available|creating|deleting|deleted|error|updating',
            'statusMessage' => '<string>',
            'subnetId' => '<string>',
            'vpcId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
mountTargets
Required: Yes
Type: Array of ListMountTargetsDescription structures

An array of mount target descriptions.

nextToken
Type: string

A pagination token to use in a subsequent request if more results are available.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags for S3 Files resources.

Parameter Syntax

$result = $client->listTagsForResource([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of tags to return in a single response.

nextToken
Type: string

A pagination token returned from a previous call to continue listing tags.

resourceId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the resource to list tags for.

Result Syntax

[
    'nextToken' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A pagination token to use in a subsequent request if more results are available.

tags
Type: Array of Tag structures

An array of tags associated with the resource.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

PutFileSystemPolicy 

$result = $client->putFileSystemPolicy([/* ... */]);
$promise = $client->putFileSystemPolicyAsync([/* ... */]);

Creates or replaces the IAM resource policy for an S3 File System to control access permissions.

Parameter Syntax

$result = $client->putFileSystemPolicy([
    'fileSystemId' => '<string>', // REQUIRED
    'policy' => '<string>', // REQUIRED
]);

Parameter Details

Members
fileSystemId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the S3 File System to apply the resource policy to.

policy
Required: Yes
Type: string

The JSON-formatted resource policy to apply to the file system. The policy defines the permissions for accessing the file system. The policy must be a valid JSON document that follows IAM policy syntax.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

PutSynchronizationConfiguration 

$result = $client->putSynchronizationConfiguration([/* ... */]);
$promise = $client->putSynchronizationConfigurationAsync([/* ... */]);

Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

Parameter Syntax

$result = $client->putSynchronizationConfiguration([
    'expirationDataRules' => [ // REQUIRED
        [
            'daysAfterLastAccess' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'fileSystemId' => '<string>', // REQUIRED
    'importDataRules' => [ // REQUIRED
        [
            'prefix' => '<string>', // REQUIRED
            'sizeLessThan' => <integer>, // REQUIRED
            'trigger' => 'ON_DIRECTORY_FIRST_ACCESS|ON_FILE_ACCESS', // REQUIRED
        ],
        // ...
    ],
    'latestVersionNumber' => <integer>,
]);

Parameter Details

Members
expirationDataRules
Required: Yes
Type: Array of ExpirationDataRule structures

An array of expiration data rules that control when cached data expires from the file system.

fileSystemId
Required: Yes
Type: string

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

importDataRules
Required: Yes
Type: Array of ImportDataRule structures

An array of import data rules that control how data is imported from S3 into the file system.

latestVersionNumber
Type: int

The version number of the current synchronization configuration. Omit this value when creating a synchronization configuration for the first time. For subsequent updates, provide this value for optimistic concurrency control. If the version number does not match the current configuration, the request fails with a ConflictException.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

ConflictException:

The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Creates tags for S3 Files resources using standard Amazon Web Services tagging APIs.

Parameter Syntax

$result = $client->tagResource([
    'resourceId' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
resourceId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the resource to add tags to.

tags
Required: Yes
Type: Array of Tag structures

An array of key-value pairs to add as tags to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from S3 Files resources.

Parameter Syntax

$result = $client->untagResource([
    'resourceId' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceId
Required: Yes
Type: string

The ID or Amazon Resource Name (ARN) of the resource to remove tags from.

tagKeys
Required: Yes
Type: Array of strings

An array of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

UpdateMountTarget 

$result = $client->updateMountTarget([/* ... */]);
$promise = $client->updateMountTargetAsync([/* ... */]);

Updates the mount target resource, specifically security group configurations.

Parameter Syntax

$result = $client->updateMountTarget([
    'mountTargetId' => '<string>', // REQUIRED
    'securityGroups' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
mountTargetId
Required: Yes
Type: string

The ID of the mount target to update.

securityGroups
Required: Yes
Type: Array of strings

An array of VPC security group IDs to associate with the mount target's network interface. This replaces the existing security groups. All security groups must belong to the same VPC as the mount target's subnet.

Result Syntax

[
    'availabilityZoneId' => '<string>',
    'fileSystemId' => '<string>',
    'ipv4Address' => '<string>',
    'ipv6Address' => '<string>',
    'mountTargetId' => '<string>',
    'networkInterfaceId' => '<string>',
    'ownerId' => '<string>',
    'securityGroups' => ['<string>', ...],
    'status' => 'available|creating|deleting|deleted|error|updating',
    'statusMessage' => '<string>',
    'subnetId' => '<string>',
    'vpcId' => '<string>',
]

Result Details

Members
availabilityZoneId
Type: string

The Availability Zone ID where the mount target is located.

fileSystemId
Type: string

The ID of the S3 File System.

ipv4Address
Type: string

The IPv4 address of the mount target.

ipv6Address
Type: string

The IPv6 address of the mount target.

mountTargetId
Required: Yes
Type: string

The ID of the mount target.

networkInterfaceId
Type: string

The ID of the network interface associated with the mount target.

ownerId
Required: Yes
Type: string

The Amazon Web Services account ID of the mount target owner.

securityGroups
Type: Array of strings

The security groups associated with the mount target.

status
Type: string

The current status of the mount target.

statusMessage
Type: string

Additional information about the mount target status.

subnetId
Required: Yes
Type: string

The ID of the subnet where the mount target is located.

vpcId
Type: string

The ID of the VPC where the mount target is located.

Errors

InternalServerException:

An internal server error occurred. Retry your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

ThrottlingException:

The request was throttled. Retry your request using exponential backoff.

ValidationException:

The input parameters are not valid. Check the parameter values and try again.

Shapes

ConflictException

Description

The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.

Members
errorCode
Required: Yes
Type: string

The error code associated with the exception.

message
Type: string
resourceId
Type: string

The identifier of the resource that caused the conflict.

resourceType
Type: string

The type of the resource that caused the conflict.

CreationPermissions

Description

Specifies the permissions to set on newly created directories within the file system.

Members
ownerGid
Required: Yes
Type: long (int|float)

The POSIX group ID to assign to newly created directories.

ownerUid
Required: Yes
Type: long (int|float)

The POSIX user ID to assign to newly created directories.

permissions
Required: Yes
Type: string

The octal permissions to assign to newly created directories.

ExpirationDataRule

Description

Specifies a rule that controls when cached data expires from the file system based on last access time.

Members
daysAfterLastAccess
Required: Yes
Type: int

The number of days after last access before cached data expires from the file system.

ImportDataRule

Description

Specifies a rule that controls how data is imported from S3 into the file system.

Members
prefix
Required: Yes
Type: string

The S3 key prefix that scopes this import rule. Only objects with keys beginning with this prefix are subject to the rule.

sizeLessThan
Required: Yes
Type: long (int|float)

The upper size limit in bytes for this import rule. Only objects with a size strictly less than this value will have data imported into the file system.

trigger
Required: Yes
Type: string

The event that triggers data import. Valid values are ON_DIRECTORY_FIRST_ACCESS (import when a directory is first accessed) and ON_FILE_ACCESS (import when a file is accessed).

InternalServerException

Description

An internal server error occurred. Retry your request.

Members
errorCode
Required: Yes
Type: string

The error code associated with the exception.

message
Type: string

ListAccessPointsDescription

Description

Contains information about an S3 File System Access Point returned in list operations.

Members
accessPointArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the access point.

accessPointId
Required: Yes
Type: string

The ID of the access point.

fileSystemId
Required: Yes
Type: string

The ID of the S3 File System.

name
Type: string

The name of the access point.

ownerId
Required: Yes
Type: string

The Amazon Web Services account ID of the access point owner.

posixUser
Type: PosixUser structure

The POSIX identity configured for this access point.

rootDirectory
Type: RootDirectory structure

The root directory configuration for this access point.

status
Required: Yes
Type: string

The current status of the access point.

ListFileSystemsDescription

Description

Contains information about an S3 File System returned in list operations.

Members
bucket
Required: Yes
Type: string

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

creationTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the file system was created.

fileSystemArn
Required: Yes
Type: string

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

fileSystemId
Required: Yes
Type: string

The ID of the file system.

name
Type: string

The name of the file system.

ownerId
Required: Yes
Type: string

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

roleArn
Required: Yes
Type: string

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

status
Required: Yes
Type: string

The current status of the file system.

statusMessage
Type: string

Additional information about the file system status.

ListMountTargetsDescription

Description

Contains information about a mount target returned in list operations.

Members
availabilityZoneId
Type: string

The Availability Zone ID where the mount target is located.

fileSystemId
Type: string

The ID of the S3 File System.

ipv4Address
Type: string

The IPv4 address of the mount target.

ipv6Address
Type: string

The IPv6 address of the mount target.

mountTargetId
Required: Yes
Type: string

The ID of the mount target.

networkInterfaceId
Type: string

The ID of the network interface associated with the mount target.

ownerId
Required: Yes
Type: string

The Amazon Web Services account ID of the mount target owner.

status
Type: string

The current status of the mount target.

statusMessage
Type: string

Additional information about the mount target status.

subnetId
Required: Yes
Type: string

The ID of the subnet where the mount target is located.

vpcId
Type: string

The ID of the VPC where the mount target is located.

PosixUser

Description

Specifies the POSIX identity with uid, gid, and secondary group IDs for user enforcement.

Members
gid
Required: Yes
Type: long (int|float)

The POSIX group ID.

secondaryGids
Type: Array of long (int|float)s

An array of secondary POSIX group IDs.

uid
Required: Yes
Type: long (int|float)

The POSIX user ID.

ResourceNotFoundException

Description

The specified resource was not found. Verify that the resource exists and that you have permission to access it.

Members
errorCode
Required: Yes
Type: string

The error code associated with the exception.

message
Type: string

RootDirectory

Description

Specifies the root directory path and optional creation permissions for newly created directories.

Members
creationPermissions
Type: CreationPermissions structure

The permissions to set on newly created directories.

path
Type: string

The path to use as the root directory for the access point.

ServiceQuotaExceededException

Description

The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.

Members
errorCode
Required: Yes
Type: string

The error code associated with the exception.

message
Type: string

Tag

Description

A key-value pair for resource tagging.

Members
key
Required: Yes
Type: string

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

value
Required: Yes
Type: string

The tag value.

ThrottlingException

Description

The request was throttled. Retry your request using exponential backoff.

Members
errorCode
Required: Yes
Type: string

The error code associated with the exception.

message
Type: string

ValidationException

Description

The input parameters are not valid. Check the parameter values and try again.

Members
errorCode
Required: Yes
Type: string

The error code associated with the exception.

message
Type: string