/AWS1/CL_S3FCREATEFILESYSRSP¶
CreateFileSystemResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_creationtime TYPE /AWS1/S3FTIMESTAMP /AWS1/S3FTIMESTAMP¶
The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).
iv_filesystemarn TYPE /AWS1/S3FFILESYSTEMARN /AWS1/S3FFILESYSTEMARN¶
The ARN for the S3 file system, in the format
arn:aws:s3files:region:account-id:file-system/file-system-id.
iv_filesystemid TYPE /AWS1/S3FFILESYSTEMID /AWS1/S3FFILESYSTEMID¶
The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls.
iv_bucket TYPE /AWS1/S3FBUCKETARN /AWS1/S3FBUCKETARN¶
The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.
iv_prefix TYPE /AWS1/S3FSTRING /AWS1/S3FSTRING¶
The prefix within the S3 bucket that scopes the file system access.
iv_clienttoken TYPE /AWS1/S3FCLIENTTOKEN /AWS1/S3FCLIENTTOKEN¶
The client token used for idempotency.
iv_kmskeyid TYPE /AWS1/S3FKMSKEYID /AWS1/S3FKMSKEYID¶
The ARN or alias of the KMS key used for encryption.
iv_status TYPE /AWS1/S3FLIFECYCLESTATE /AWS1/S3FLIFECYCLESTATE¶
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), orUPDATING(the file system is being updated).
iv_statusmessage TYPE /AWS1/S3FSTATUSMESSAGE /AWS1/S3FSTATUSMESSAGE¶
Additional information about the file system status. This field provides more details when the status is
ERROR, or during state transitions.
iv_rolearn TYPE /AWS1/S3FROLEARN /AWS1/S3FROLEARN¶
The ARN of the IAM role used for S3 access.
iv_ownerid TYPE /AWS1/S3FAWSACCOUNTID /AWS1/S3FAWSACCOUNTID¶
The Amazon Web Services account ID of the file system owner.
it_tags TYPE /AWS1/CL_S3FTAG=>TT_TAGLIST TT_TAGLIST¶
The tags associated with the file system.
iv_name TYPE /AWS1/S3FTAGVALUE /AWS1/S3FTAGVALUE¶
The name of the file system, derived from the
Nametag if present.
Queryable Attributes¶
creationTime¶
The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
fileSystemArn¶
The ARN for the S3 file system, in the format
arn:aws:s3files:region:account-id:file-system/file-system-id.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FILESYSTEMARN() |
Getter for FILESYSTEMARN, with configurable default |
ASK_FILESYSTEMARN() |
Getter for FILESYSTEMARN w/ exceptions if field has no value |
HAS_FILESYSTEMARN() |
Determine if FILESYSTEMARN has a value |
fileSystemId¶
The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FILESYSTEMID() |
Getter for FILESYSTEMID, with configurable default |
ASK_FILESYSTEMID() |
Getter for FILESYSTEMID w/ exceptions if field has no value |
HAS_FILESYSTEMID() |
Determine if FILESYSTEMID has a value |
bucket¶
The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUCKET() |
Getter for BUCKET, with configurable default |
ASK_BUCKET() |
Getter for BUCKET w/ exceptions if field has no value |
HAS_BUCKET() |
Determine if BUCKET has a value |
prefix¶
The prefix within the S3 bucket that scopes the file system access.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PREFIX() |
Getter for PREFIX, with configurable default |
ASK_PREFIX() |
Getter for PREFIX w/ exceptions if field has no value |
HAS_PREFIX() |
Determine if PREFIX has a value |
clientToken¶
The client token used for idempotency.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTTOKEN() |
Getter for CLIENTTOKEN, with configurable default |
ASK_CLIENTTOKEN() |
Getter for CLIENTTOKEN w/ exceptions if field has no value |
HAS_CLIENTTOKEN() |
Determine if CLIENTTOKEN has a value |
kmsKeyId¶
The ARN or alias of the KMS key used for encryption.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYID() |
Getter for KMSKEYID, with configurable default |
ASK_KMSKEYID() |
Getter for KMSKEYID w/ exceptions if field has no value |
HAS_KMSKEYID() |
Determine if KMSKEYID has a value |
status¶
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), orUPDATING(the file system is being updated).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
statusMessage¶
Additional information about the file system status. This field provides more details when the status is
ERROR, or during state transitions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSMESSAGE() |
Getter for STATUSMESSAGE, with configurable default |
ASK_STATUSMESSAGE() |
Getter for STATUSMESSAGE w/ exceptions if field has no value |
HAS_STATUSMESSAGE() |
Determine if STATUSMESSAGE has a value |
roleArn¶
The ARN of the IAM role used for S3 access.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
ownerId¶
The Amazon Web Services account ID of the file system owner.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OWNERID() |
Getter for OWNERID, with configurable default |
ASK_OWNERID() |
Getter for OWNERID w/ exceptions if field has no value |
HAS_OWNERID() |
Determine if OWNERID has a value |
tags¶
The tags associated with the file system.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
name¶
The name of the file system, derived from the
Nametag if present.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |