Skip to content

GetFileSystemResponse

Source code in docs_src/capo_s3files/types/get_file_system_response.py
class GetFileSystemResponse(TypedDict, closed=True):
    creation_time: NotRequired["datetime.datetime"]
    """<p>The time when the file system was created.</p>"""
    file_system_arn: NotRequired["capo_s3files.types.file_system_arn.FileSystemArn"]
    """<p>The Amazon Resource Name (ARN) of the file system.</p>"""
    file_system_id: NotRequired["capo_s3files.types.file_system_id.FileSystemId"]
    """<p>The ID of the file system.</p>"""
    bucket: NotRequired["capo_s3files.types.bucket_arn.BucketArn"]
    """<p>The Amazon Resource Name (ARN) of the S3 bucket.</p>"""
    prefix: "str"
    """<p>The prefix in the S3 bucket that the file system provides access to.</p>"""
    client_token: NotRequired["capo_s3files.types.client_token.ClientToken"]
    """<p>The client token used for idempotency when the file system was created.</p>"""
    kms_key_id: NotRequired["capo_s3files.types.kms_key_id.KmsKeyId"]
    """<p>The Amazon Resource Name (ARN) of the Amazon Web Services KMS key used for encryption.</p>"""
    status: NotRequired["capo_s3files.types.life_cycle_state.LifeCycleState"]
    """<p>The current status of the file system.</p>"""
    status_message: NotRequired["capo_s3files.types.status_message.StatusMessage"]
    """<p>Additional information about the file system status.</p>"""
    role_arn: NotRequired["capo_s3files.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (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.</p>"""

bucket instance-attribute

bucket: NotRequired[BucketArn]

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

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

creation_time instance-attribute

creation_time: NotRequired[datetime]

The time when the file system was created.

file_system_arn instance-attribute

file_system_arn: NotRequired[FileSystemArn]

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

file_system_id instance-attribute

file_system_id: NotRequired[FileSystemId]

The ID of the file system.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

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

name instance-attribute

name: NotRequired[TagValue]

The name of the file system.

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 in the S3 bucket that the file system provides access to.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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

status instance-attribute

status: NotRequired[LifeCycleState]

The current status of the file system.

status_message instance-attribute

status_message: NotRequired[StatusMessage]

Additional information about the file system status.

tags instance-attribute

tags: NotRequired[TagList]

The tags associated with the file system.