@rainbow-o23/n8 v1.0.59

o23/n8

o23/n8 provides the pipeline steps related to AWS.

AWS Credential Identity Environment Parameters

AWS Region Step Environment Parameters

AWS S3 Steps

S3 pipeline steps are actually a simple wrapper for the AWS SDK, so their parameters and returns follow the specifications of @aws-sdk/client-s3.

Environment Parameters

CLIENT represents client name.

Use RegionClientManager.registerS3ClientCreator to register client creator.

Default

When aws.s3.CLIENT.client.type=default or not presents:

default client type read AWS credential identity and region environment parameters.

Constructor Parameters

Request and Response

export interface AbstractS3PipelineStepInFragment {
	Bucket?: string | undefined;
}

export interface AbstractS3PipelineStepOutFragment {
}

Get Object Step

Constructor Parameters

Request and Response

export type S3GetObjectPipelineStepInFragment = AbstractS3PipelineStepInFragment & GetObjectCommandInput;
export type S3GetObjectPipelineStepOutFragment = AbstractS3PipelineStepOutFragment & GetObjectCommandOutput;

Put Object Step

Request and Response

export type S3PutObjectPipelineStepInFragment = AbstractS3PipelineStepInFragment & PutObjectCommandInput;
export type S3PutObjectPipelineStepOutFragment = AbstractS3PipelineStepOutFragment & PutObjectCommandOutput;

Delete Object Step

Request and Response

export type S3DeleteObjectPipelineStepInFragment = AbstractS3PipelineStepInFragment & DeleteObjectCommandInput;
export type S3DeleteObjectPipelineStepOutFragment = AbstractS3PipelineStepOutFragment & DeleteObjectCommandOutput;

List Objects Step

Request and Response

export type S3ListObjectsPipelineStepInFragment = AbstractS3PipelineStepInFragment & ListObjectsV2CommandInput;
export type S3ListObjectsPipelineStepOutFragment = AbstractS3PipelineStepOutFragment & ListObjectsV2CommandOutput;