AWS GetFileSystem
CertifiedGet an Amazon S3 Files file system
AWS GetFileSystem
Get an Amazon S3 Files file system
Retrieves the metadata and status of an existing S3 Files file system.
type: io.kestra.plugin.aws.s3.files.GetFileSystemExamples
id: aws_s3_files_get_filesystem
namespace: company.team
tasks:
- id: get_fs
type: io.kestra.plugin.aws.s3.files.GetFileSystem
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "us-east-1"
fileSystemId: "fs-0123456789abcdef0"
Properties
fileSystemId *Requiredstring
File system ID
The ID of the file system to retrieve (e.g. fs-0123456789abcdef0).
accessKeyId string
Access Key Id in order to connect to AWS
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
compatibilityMode booleanstring
Enable compatibility mode
Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.
endpointOverride string
The endpoint with which the SDK should communicate
This property allows you to use a different S3 compatible storage backend.
forcePathStyle booleanstring
Force path style access
Must only be used when compatibilityMode is enabled.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
region string
AWS region with which the SDK should communicate
secretKeyId string
Secret Key Id in order to connect to AWS
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
sessionToken string
AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsEndpointOverride string
The AWS STS endpoint with which the SDKClient should communicate
stsRoleArn string
AWS STS Role
The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsRoleExternalId string
AWS STS External Id
A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.
stsRoleSessionDuration string
PT15MAWS STS Session duration
The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.
stsRoleSessionName string
AWS STS Session name
This property is only used when an stsRoleArn is defined.
Outputs
fileSystem
The full file system details
io.kestra.plugin.aws.s3.files.models.FileSystem
Bucket
The S3 bucket backing the file system.
Client token
Idempotency token associated with the file system.
Creation time
Creation timestamp (epoch seconds).
File system ARN
The ARN of the file system.
File system ID
Unique identifier of the S3 Files file system.
KMS key ID
KMS key used for encryption, if configured.
Name
The file system name.
Owner ID
AWS account ID that owns the file system.
Prefix
The bucket prefix exposed by the file system, if any.
Role ARN
IAM role ARN used by the file system to access the bucket.
Status
Current lifecycle status of the file system.
Status message
Human-readable detail about the current status.
Tags
Resource tags attached to the file system.
io.kestra.plugin.aws.s3.files.models.FileSystem-Tag
Key
Tag key.
Value
Tag value.
