Skip to content

CreateFileSystemResponse

Source code in docs_src/capo_s3files/types/create_file_system_response.py
class CreateFileSystemResponse(TypedDict, closed=True):
    creation_time: NotRequired["datetime.datetime"]
    """<p>The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).</p>"""
    file_system_arn: NotRequired["capo_s3files.types.file_system_arn.FileSystemArn"]
    """<p>The ARN for the S3 file system, in the format <code>arn:aws:s3files:region:account-id:file-system/file-system-id</code>.</p>"""
    file_system_id: NotRequired["capo_s3files.types.file_system_id.FileSystemId"]
    """<p>The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls.</p>"""
    bucket: NotRequired["capo_s3files.types.bucket_arn.BucketArn"]
    """<p>The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.</p>"""
    prefix: "str"
    """<p>The prefix within the S3 bucket that scopes the file system access.</p>"""
    client_token: NotRequired["capo_s3files.types.client_token.ClientToken"]
    """<p>The client token used for idempotency.</p>"""
    kms_key_id: NotRequired["capo_s3files.types.kms_key_id.KmsKeyId"]
    """<p>The ARN or alias of the KMS key used for encryption.</p>"""
    status: NotRequired["capo_s3files.types.life_cycle_state.LifeCycleState"]
    """<p>The lifecycle state of the file system. Valid values are: <code>AVAILABLE</code> (the file system is available for use), <code>CREATING</code> (the file system is being created), <code>DELETING</code> (the file system is being deleted), <code>DELETED</code> (the file system has been deleted), <code>ERROR</code> (the file system is in an error state), or <code>UPDATING</code> (the file system is being updated).</p>"""
    status_message: NotRequired["capo_s3files.types.status_message.StatusMessage"]
    """<p>Additional information about the file system status. This field provides more details when the status is <code>ERROR</code>, or during state transitions.</p>"""
    role_arn: NotRequired["capo_s3files.types.role_arn.RoleArn"]
    """<p>The ARN of the IAM role used for S3 access.</p>"""
    owner_id: NotRequired["capo_s3files.types.aws_account_id.AwsAccountId"]
    """<p>The Amazon Web Services account ID of the file system owner.</p>"""
    tags: NotRequired["capo_s3files.types.tag_list.TagList"]
    """<p>The tags associated with the file system.</p>"""
    name: NotRequired["capo_s3files.types.tag_value.TagValue"]
    """<p>The name of the file system, derived from the <code>Name</code> tag if present.</p>"""

bucket instance-attribute

bucket: NotRequired[BucketArn]

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

client_token instance-attribute

client_token: NotRequired[ClientToken]

The client token used for idempotency.

creation_time instance-attribute

creation_time: NotRequired[datetime]

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

file_system_arn instance-attribute

file_system_arn: NotRequired[FileSystemArn]

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

file_system_id instance-attribute

file_system_id: NotRequired[FileSystemId]

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

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

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

name instance-attribute

name: NotRequired[TagValue]

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

owner_id instance-attribute

owner_id: NotRequired[AwsAccountId]

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

prefix instance-attribute

prefix: str

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

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The ARN of the IAM role used for S3 access.

status instance-attribute

status: NotRequired[LifeCycleState]

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

status_message instance-attribute

status_message: NotRequired[StatusMessage]

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

tags instance-attribute

tags: NotRequired[TagList]

The tags associated with the file system.