@pulumi/aws/s3/getObjects.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * > **NOTE on `maxKeys`:** Retrieving very large numbers of keys can adversely affect the provider's performance.
 *
 * The objects data source returns keys (i.e., file names) and other metadata about objects in an S3 bucket.
 */
export declare function getObjects(args: GetObjectsArgs, opts?: pulumi.InvokeOptions): Promise<GetObjectsResult>;
/**
 * A collection of arguments for invoking getObjects.
 */
export interface GetObjectsArgs {
    /**
     * Lists object keys in this S3 bucket. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified
     */
    bucket: string;
    /**
     * Character used to group keys (Default: none)
     */
    delimiter?: string;
    /**
     * Encodes keys using this method (Default: none; besides none, only "url" can be used)
     */
    encodingType?: string;
    /**
     * Boolean specifying whether to populate the owner list (Default: false)
     */
    fetchOwner?: boolean;
    /**
     * Maximum object keys to return (Default: 1000)
     */
    maxKeys?: number;
    /**
     * Limits results to object keys with this prefix (Default: none)
     */
    prefix?: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If included, the only valid value is `requester`.
     */
    requestPayer?: string;
    /**
     * Returns key names lexicographically after a specific object key in your bucket (Default: none; S3 lists object keys in UTF-8 character encoding in lexicographical order)
     */
    startAfter?: string;
}
/**
 * A collection of values returned by getObjects.
 */
export interface GetObjectsResult {
    readonly bucket: string;
    /**
     * List of any keys between `prefix` and the next occurrence of `delimiter` (i.e., similar to subdirectories of the `prefix` "directory"); the list is only returned when you specify `delimiter`
     */
    readonly commonPrefixes: string[];
    readonly delimiter?: string;
    readonly encodingType?: string;
    readonly fetchOwner?: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * List of strings representing object keys
     */
    readonly keys: string[];
    readonly maxKeys?: number;
    /**
     * List of strings representing object owner IDs (see `fetchOwner` above)
     */
    readonly owners: string[];
    readonly prefix?: string;
    readonly region: string;
    /**
     * If present, indicates that the requester was successfully charged for the request.
     */
    readonly requestCharged: string;
    readonly requestPayer?: string;
    readonly startAfter?: string;
}
/**
 * > **NOTE on `maxKeys`:** Retrieving very large numbers of keys can adversely affect the provider's performance.
 *
 * The objects data source returns keys (i.e., file names) and other metadata about objects in an S3 bucket.
 */
export declare function getObjectsOutput(args: GetObjectsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetObjectsResult>;
/**
 * A collection of arguments for invoking getObjects.
 */
export interface GetObjectsOutputArgs {
    /**
     * Lists object keys in this S3 bucket. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified
     */
    bucket: pulumi.Input<string>;
    /**
     * Character used to group keys (Default: none)
     */
    delimiter?: pulumi.Input<string>;
    /**
     * Encodes keys using this method (Default: none; besides none, only "url" can be used)
     */
    encodingType?: pulumi.Input<string>;
    /**
     * Boolean specifying whether to populate the owner list (Default: false)
     */
    fetchOwner?: pulumi.Input<boolean>;
    /**
     * Maximum object keys to return (Default: 1000)
     */
    maxKeys?: pulumi.Input<number>;
    /**
     * Limits results to object keys with this prefix (Default: none)
     */
    prefix?: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If included, the only valid value is `requester`.
     */
    requestPayer?: pulumi.Input<string>;
    /**
     * Returns key names lexicographically after a specific object key in your bucket (Default: none; S3 lists object keys in UTF-8 character encoding in lexicographical order)
     */
    startAfter?: pulumi.Input<string>;
}