### Install @effect-aws/client-cloudfront Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudfront/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-cloudfront ``` -------------------------------- ### Install @effect-aws/client-lambda Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-lambda/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-lambda ``` -------------------------------- ### Install @effect-aws/client-opensearch-serverless Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-opensearch-serverless/README.md Install the package using npm. This is the first step before using the client. ```bash npm install --save @effect-aws/client-opensearch-serverless ``` -------------------------------- ### Install @effect-aws/client-opensearch Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-opensearch/README.md Install the package using npm. This is the first step before using the client. ```bash npm install --save @effect-aws/client-opensearch ``` -------------------------------- ### Install @effect-aws/client-iot-events Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-events/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-iot-events ``` -------------------------------- ### Install @effect-aws/client-scheduler Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-scheduler/README.md Install the package using npm. This is the first step before using the client. ```bash npm install --save @effect-aws/client-scheduler ``` -------------------------------- ### Install @effect-aws/client-dsql Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-dsql/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-dsql ``` -------------------------------- ### Install @effect-aws/client-api-gateway-v2 Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-api-gateway-v2/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-api-gateway-v2 ``` -------------------------------- ### Install @effect-aws/client-sfn Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sfn/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-sfn ``` -------------------------------- ### Install @effect-aws/client-iot Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot/README.md Install the package using npm. This is the first step before using the client. ```bash npm install --save @effect-aws/client-iot ``` -------------------------------- ### Install @effect-aws/lambda Source: https://github.com/floydspace/effect-aws/blob/main/packages/lambda/README.md Install the package using npm. ```bash npm install --save @effect-aws/lambda ``` -------------------------------- ### Install @effect-aws/client-sqs Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sqs/README.md Install the package using npm. This is the first step before using any of its functionalities. ```bash npm install --save @effect-aws/client-sqs ``` -------------------------------- ### Install @effect-aws/lib-dynamodb Source: https://github.com/floydspace/effect-aws/blob/main/packages/lib-dynamodb/README.md Install the library using npm. ```bash npm install --save @effect-aws/lib-dynamodb ``` -------------------------------- ### Install @effect-aws/client-glue Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-glue/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-glue ``` -------------------------------- ### Install @effect-aws/client-iot-wireless Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-wireless/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-iot-wireless ``` -------------------------------- ### Install @effect-aws/client-bedrock-runtime Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-bedrock-runtime/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-bedrock-runtime ``` -------------------------------- ### Install @effect-aws/client-iot-events-data Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-events-data/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/client-iot-events-data ``` -------------------------------- ### Install @effect-aws/client-timestream-query Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-timestream-query/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/client-timestream-query ``` -------------------------------- ### Install @effect-aws/client-sts Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sts/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-sts ``` -------------------------------- ### Install @effect-aws/client-api-gateway Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-api-gateway/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/client-api-gateway ``` -------------------------------- ### Install @effect-aws/client-ssm Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ssm/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/client-ssm ``` -------------------------------- ### Install @effect-aws/client-kafka Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-kafka/README.md Install the package using npm. This is the first step before using the client. ```bash npm install --save @effect-aws/client-kafka ``` -------------------------------- ### Install @effect-aws/http-handler Source: https://github.com/floydspace/effect-aws/blob/main/packages/http-handler/README.md Install the package using npm. ```bash npm install --save @effect-aws/http-handler ``` -------------------------------- ### Install @effect-aws/client-s3 Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-s3/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-s3 ``` -------------------------------- ### Install @effect-aws/client-data-pipeline Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-data-pipeline/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/client-data-pipeline ``` -------------------------------- ### Install @effect-aws/client-sesv2 Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sesv2/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-sesv2 ``` -------------------------------- ### Install @effect-aws/client-ses Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ses/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-ses ``` -------------------------------- ### Install @effect-aws/client-ivs Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ivs/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-ivs ``` -------------------------------- ### Install @effect-aws/client-sns Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sns/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-sns ``` -------------------------------- ### Install @effect-aws/client-kms Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-kms/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-kms ``` -------------------------------- ### Install @effect-aws/client-iot-jobs-data-plane Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-jobs-data-plane/README.md Install the package using npm. This is the first step before using the client. ```bash npm install --save @effect-aws/client-iot-jobs-data-plane ``` -------------------------------- ### Install @effect-aws/client-bedrock Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-bedrock/README.md Install the package using npm. This is the first step before using the client. ```bash npm install --save @effect-aws/client-bedrock ``` -------------------------------- ### Install @effect-aws/client-iot-data-plane Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-data-plane/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/client-iot-data-plane ``` -------------------------------- ### Install @effect-aws/client-timestream-influxdb Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-timestream-influxdb/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-timestream-influxdb ``` -------------------------------- ### Install @effect-aws/client-cloudtrail Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudtrail/README.md Install the CloudTrail client package using npm. ```bash npm install --save @effect-aws/client-cloudtrail ``` -------------------------------- ### Install @effect-aws/client-textract Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-textract/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/client-textract ``` -------------------------------- ### Use Custom AutoScalingClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-auto-scaling/README.md Example of using a custom AutoScalingClient instance with a specified region. Requires AWS SDK v3 client setup. ```typescript import { AutoScaling } from "@effect-aws/client-auto-scaling"; const program = AutoScaling.describeAutoScalingGroups(args); const result = await pipe( program, Effect.provide( AutoScaling.baseLayer(() => new AutoScalingClient({ region: "eu-central-1" })), ), Effect.runPromise, ); ``` -------------------------------- ### Install @effect-aws/client-organizations Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-organizations/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-organizations ``` -------------------------------- ### Install @effect-aws/client-auto-scaling Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-auto-scaling/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-auto-scaling ``` -------------------------------- ### Install @effect-aws/client-mq Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-mq/README.md Install the @effect-aws/client-mq package using npm. ```bash npm install --save @effect-aws/client-mq ``` -------------------------------- ### Install @effect-aws/client-cloudwatch-logs Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudwatch-logs/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-cloudwatch-logs ``` -------------------------------- ### Install @effect-aws/client-account Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-account/README.md Install the @effect-aws/client-account package using npm. ```bash npm install --save @effect-aws/client-account ``` -------------------------------- ### Install @effect-aws/client-kafkaconnect Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-kafkaconnect/README.md Install the KafkaConnect client package using npm. ```bash npm install --save @effect-aws/client-kafkaconnect ``` -------------------------------- ### Install @effect-aws/dynamodb Source: https://github.com/floydspace/effect-aws/blob/main/packages/dynamodb/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/dynamodb ``` -------------------------------- ### Install @effect-aws/client-firehose Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-firehose/README.md Install the package using npm. This is the first step before using the Firehose client. ```bash npm install --save @effect-aws/client-firehose ``` -------------------------------- ### Install @effect-aws/client-ecr Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ecr/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-ecr ``` -------------------------------- ### Install @effect-aws/client-dynamodb Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-dynamodb/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/client-dynamodb ``` -------------------------------- ### Install @effect-aws/client-cognito-identity-provider Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cognito-identity-provider/README.md Install the package using npm. This is the first step before using the library. ```bash npm install --save @effect-aws/client-cognito-identity-provider ``` -------------------------------- ### Install @effect-aws/client-cloudformation Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudformation/README.md Install the package using npm. This is the first step before using the CloudFormation client. ```bash npm install --save @effect-aws/client-cloudformation ``` -------------------------------- ### Install @effect-aws/client-athena Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-athena/README.md Install the package using npm. ```bash npm install --save @effect-aws/client-athena ``` -------------------------------- ### Install @effect-aws/client-iam Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iam/README.md Install the @effect-aws/client-iam package using npm. ```bash npm install --save @effect-aws/client-iam ``` -------------------------------- ### Install @effect-aws/client-ecs Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ecs/README.md Install the @effect-aws/client-ecs package using npm. ```bash npm install --save @effect-aws/client-ecs ``` -------------------------------- ### Install @effect-aws/client-kinesis Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-kinesis/README.md Install the @effect-aws/client-kinesis package using npm. ```bash npm install --save @effect-aws/client-kinesis ``` -------------------------------- ### Install @effect-aws/client-cloudsearch Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudsearch/README.md Install the package using npm. This is the first step before using the CloudSearch client. ```bash npm install --save @effect-aws/client-cloudsearch ``` -------------------------------- ### Install @effect-aws/client-cloudwatch-events Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudwatch-events/README.md Install the CloudWatch Events client package using npm. ```bash npm install --save @effect-aws/client-cloudwatch-events ``` -------------------------------- ### Install @effect-aws/client-rds Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-rds/README.md Install the package using npm. This is the first step before using the RDS client. ```bash npm install --save @effect-aws/client-rds ``` -------------------------------- ### Install @effect-aws/client-eventbridge Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-eventbridge/README.md Install the package using npm. This is the first step before using the EventBridge client. ```bash npm install --save @effect-aws/client-eventbridge ``` -------------------------------- ### Install @effect-aws/s3 Source: https://github.com/floydspace/effect-aws/blob/main/packages/s3/README.md Install the @effect-aws/s3 package and its S3 client dependency. ```bash npm install --save @effect-aws/s3 @effect-aws/client-s3 ``` -------------------------------- ### Install @effect-aws/powertools-tracer Source: https://github.com/floydspace/effect-aws/blob/main/packages/powertools-tracer/README.md Install the package and its peer dependency. `@aws-lambda-powertools/tracer` is a peer dependency. ```bash npm install --save @effect-aws/powertools-tracer @aws-lambda-powertools/tracer ``` -------------------------------- ### Install @effect-aws/ssm and @effect-aws/client-ssm Source: https://github.com/floydspace/effect-aws/blob/main/packages/ssm/README.md Install the necessary packages for using AWS Systems Manager Parameter Store with Effect. ```bash npm install --save @effect-aws/ssm @effect-aws/client-ssm ``` -------------------------------- ### Use Default IoTClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot/README.md This example shows how to use the default IoTClient instance. It requires providing the default layer to the program. ```typescript import { IoT } from "@effect-aws/client-iot"; const program = IoT.describeJob(args); const result = pipe( program, Effect.provide(IoT.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Install @effect-aws/client-api-gateway-management-api Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-api-gateway-management-api/README.md Install the package using npm. This command adds the necessary dependency to your project. ```bash npm install --save @effect-aws/client-api-gateway-management-api ``` -------------------------------- ### Start Execution with Custom Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sfn/README.md Start a state machine execution using a custom SFNClient instance. This allows for specific configurations like the AWS region. ```typescript import { SFN } from "@effect-aws/client-sfn"; const program = SFN.startExecution(args); const result = await pipe( program, Effect.provide( SFN.baseLayer(() => new SFNClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### Install @effect-aws/client-ec2 Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ec2/README.md Install the package using npm. This is the first step before using any EC2 functionalities. ```bash npm install --save @effect-aws/client-ec2 ``` -------------------------------- ### Install @effect-aws/secrets-manager and @effect-aws/client-secrets-manager Source: https://github.com/floydspace/effect-aws/blob/main/packages/secrets-manager/README.md Install the necessary packages for using AWS Secrets Manager with Effect. ```bash npm install --save @effect-aws/secrets-manager @effect-aws/client-secrets-manager ``` -------------------------------- ### Start Execution with Default Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sfn/README.md Use the default SFNClient instance to start a state machine execution. Ensure the default layer is provided. ```typescript import { SFN } from "@effect-aws/client-sfn"; const program = SFN.startExecution(args); const result = pipe( program, Effect.provide(SFN.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Install @effect-aws/client-timestream-write Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-timestream-write/README.md Install the package using npm. This command adds the necessary dependency to your project. ```bash npm install --save @effect-aws/client-timestream-write ``` -------------------------------- ### Start Execution with Custom Client Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sfn/README.md Start a state machine execution using a custom SFNClient configuration object. This method uses `runPromiseExit` for execution. ```typescript import { SFN } from "@effect-aws/client-sfn"; const program = SFN.startExecution(args); const result = await pipe( program, Effect.provide(SFN.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Install @effect-aws/client-secrets-manager Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-secrets-manager/README.md Install the package using npm. This is the first step before using the SecretsManager client. ```bash npm install --save @effect-aws/client-secrets-manager ``` -------------------------------- ### Install @effect-aws/powertools-logger Source: https://github.com/floydspace/effect-aws/blob/main/packages/powertools-logger/README.md Install the package and its peer dependency. Ensure you are using v1.9.0 or higher of @aws-lambda-powertools/logger. ```bash npm install --save @effect-aws/powertools-logger @aws-lambda-powertools/logger ``` -------------------------------- ### Install @effect-aws/client-cloudwatch Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudwatch/README.md Install the package using npm. This command adds the CloudWatch client to your project dependencies. ```bash npm install --save @effect-aws/client-cloudwatch ``` -------------------------------- ### Install @effect-aws/client-elasticache Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-elasticache/README.md Install the package using npm. This command adds the necessary dependency to your project. ```bash npm install --save @effect-aws/client-elasticache ``` -------------------------------- ### Start Query Execution with Custom Configuration Layer Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-athena/README.md Start a query execution using a custom configuration layer. This method allows providing configuration options directly to the layer and uses `runPromiseExit`. ```typescript import { Athena } from "@effect-aws/client-athena"; const program = Athena.startQueryExecution(args); const result = await pipe( program, Effect.provide(Athena.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Install @effect-aws/client-codedeploy Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-codedeploy/README.md Install the package using npm. This command adds the @effect-aws/client-codedeploy package to your project dependencies. ```bash npm install --save @effect-aws/client-codedeploy ``` -------------------------------- ### Install @effect-aws/client-s3 using bun Source: https://github.com/floydspace/effect-aws/blob/main/pages/docs/getting-started.md Install the S3 service package using bun. This command is applicable for other AWS services by replacing 's3' with the desired service name. ```sh bun add @effect-aws/client-s3 ``` -------------------------------- ### Use Default BedrockClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-bedrock/README.md This example shows how to use the default BedrockClient instance. Ensure the default layer is provided to the Effect runtime. ```typescript import { Bedrock } from "@effect-aws/client-bedrock"; const program = Bedrock.listCustomModels(args); const result = pipe( program, Effect.provide(Bedrock.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Use Default AutoScalingClient Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-auto-scaling/README.md Example of using the AutoScaling client with a default instance. Ensure Effect-TS is set up. ```typescript import { AutoScaling } from "@effect-aws/client-auto-scaling"; const program = AutoScaling.describeAutoScalingGroups(args); const result = pipe( program, Effect.provide(AutoScaling.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Use Default STSClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sts/README.md Example of using the STS client with a default instance. Requires `Effect.provide` with `STS.defaultLayer`. ```typescript import { STS } from "@effect-aws/client-sts"; const program = STS.getCallerIdentity(args); const result = pipe( program, Effect.provide(STS.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Start Command Execution with Default Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-jobs-data-plane/README.md Execute a command using the default IoTJobsDataPlaneClient instance. Ensure the default layer is provided to the effect. ```typescript import { IoTJobsDataPlane } from "@effect-aws/client-iot-jobs-data-plane"; const program = IoTJobsDataPlane.startCommandExecution(args); const result = pipe( program, Effect.provide(IoTJobsDataPlane.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Start Query Execution with Default Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-athena/README.md Use the default AthenaClient instance to start a query execution. Requires providing the default layer. ```typescript import { Athena } from "@effect-aws/client-athena"; const program = Athena.startQueryExecution(args); const result = pipe( program, Effect.provide(Athena.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Install Dependencies Source: https://github.com/floydspace/effect-aws/blob/main/README.md Install project dependencies using pnpm. Ensure you are using pnpm version 9.x. If introducing new dependencies, update `.projenrc.ts` and run `pnpm default`. ```shell pnpm install ``` -------------------------------- ### Use Custom STSClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sts/README.md Example of using the STS client with custom configuration. Requires `Effect.provide` with `STS.layer` and `Effect.runPromiseExit`. ```typescript import { STS } from "@effect-aws/client-sts"; const program = STS.getCallerIdentity(args); const result = await pipe( program, Effect.provide(STS.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### List Brokers with Custom MqClient Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-mq/README.md Create and provide a custom MqClient instance with a specified region. This example uses `Effect.runPromise` to execute the program. ```typescript import { Mq } from "@effect-aws/client-mq"; const program = Mq.listBrokers(args); const result = await pipe( program, Effect.provide( Mq.baseLayer(() => new MqClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### Install @effect-aws/client-s3 using npm Source: https://github.com/floydspace/effect-aws/blob/main/pages/docs/getting-started.md Install the S3 service package using npm. This command is applicable for other AWS services by replacing 's3' with the desired service name. ```sh npm install @effect-aws/client-s3 ``` -------------------------------- ### Install @effect-aws/client-s3 using pnpm Source: https://github.com/floydspace/effect-aws/blob/main/pages/docs/getting-started.md Install the S3 service package using pnpm. This command is applicable for other AWS services by replacing 's3' with the desired service name. ```sh pnpm add @effect-aws/client-s3 ``` -------------------------------- ### Install @effect-aws/client-s3 using yarn Source: https://github.com/floydspace/effect-aws/blob/main/pages/docs/getting-started.md Install the S3 service package using yarn. This command is applicable for other AWS services by replacing 's3' with the desired service name. ```sh yarn add @effect-aws/client-s3 ``` -------------------------------- ### Use Default IoTEventsDataClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-events-data/README.md Example of using the default IoTEventsDataClient instance. This is suitable for most common use cases. ```typescript import { IoTEventsData } from "@effect-aws/client-iot-events-data"; const program = IoTEventsData.describeAlarm(args); const result = pipe( program, Effect.provide(IoTEventsData.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Start Command Execution with Custom Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-jobs-data-plane/README.md Execute a command using a custom-configured IoTJobsDataPlaneClient instance. This allows specifying client options like the region. ```typescript import { IoTJobsDataPlane } from "@effect-aws/client-iot-jobs-data-plane"; const program = IoTJobsDataPlane.startCommandExecution(args); const result = await pipe( program, Effect.provide( IoTJobsDataPlane.baseLayer(() => new IoTJobsDataPlaneClient({ region: "eu-central-1" })), ), Effect.runPromise, ); ``` -------------------------------- ### Use Custom IoTWirelessClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-wireless/README.md Example of providing custom configuration for the IoTWirelessClient using IoTWireless.layer. Requires Effect-TS. ```typescript import { IoTWireless } from "@effect-aws/client-iot-wireless"; const program = IoTWireless.listDestinations(args); const result = await pipe( program, Effect.provide(IoTWireless.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Start Query Execution with Custom Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-athena/README.md Start a query execution using a custom AthenaClient instance. Provide a base layer with a new AthenaClient configured for a specific region. ```typescript import { Athena } from "@effect-aws/client-athena"; const program = Athena.startQueryExecution(args); const result = await pipe( program, Effect.provide( Athena.baseLayer(() => new AthenaClient({ region: "eu-central-1" })), ), Effect.runPromise, ); ``` -------------------------------- ### Use Custom IoTEventsDataClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-events-data/README.md Example of configuring the IoTEventsDataClient with specific options. This allows fine-grained control over the client's behavior. ```typescript import { IoTEventsData } from "@effect-aws/client-iot-events-data"; const program = IoTEventsData.describeAlarm(args); const result = await pipe( program, Effect.provide(IoTEventsData.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Use Custom IoTWirelessClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-wireless/README.md Example of providing a custom IoTWirelessClient instance with a specific region. Requires Effect-TS. ```typescript import { IoTWireless } from "@effect-aws/client-iot-wireless"; const program = IoTWireless.listDestinations(args); const result = await pipe( program, Effect.provide( IoTWireless.baseLayer(() => new IoTWirelessClient({ region: "eu-central-1" })), ), Effect.runPromise, ); ``` -------------------------------- ### Use Custom CloudWatchClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudwatch/README.md This example shows how to configure the CloudWatch client with specific settings, such as the region. The `layer` function simplifies providing a configured client. ```typescript import { CloudWatch } from "@effect-aws/client-cloudwatch"; const program = CloudWatch.describeAlarms(args); const result = await pipe( program, Effect.provide(CloudWatch.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### List Brokers with Custom MqClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-mq/README.md Configure a custom MqClient with a specific region using `Mq.layer`. This example uses `Effect.runPromiseExit` for execution. ```typescript import { Mq } from "@effect-aws/client-mq"; const program = Mq.listBrokers(args); const result = await pipe( program, Effect.provide(Mq.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Install @effect-aws/commons Source: https://github.com/floydspace/effect-aws/blob/main/packages/commons/README.md Use npm to install the @effect-aws/commons package. This command is used for adding the package to your project dependencies. ```bash npm install --save @effect-aws/commons ``` -------------------------------- ### Use Custom IoTClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot/README.md This example demonstrates using a custom IoTClient instance with a specified region. It requires providing a base layer with the custom client configuration. ```typescript import { IoT } from "@effect-aws/client-iot"; const program = IoT.describeJob(args); const result = await pipe( program, Effect.provide( IoT.baseLayer(() => new IoTClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### Use Default TextractClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-textract/README.md Example of using the Textract client with its default instance. Ensure Effect-TS is set up. ```typescript import { Textract } from "@effect-aws/client-textract"; const program = Textract.listAdapters(args); const result = pipe( program, Effect.provide(Textract.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Use Default SchedulerClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-scheduler/README.md This example shows how to use the Scheduler client with its default instance. Ensure Effect-TS is set up correctly. ```typescript import { Scheduler } from "@effect-aws/client-scheduler"; const program = Scheduler.tagResource(args); const result = pipe( program, Effect.provide(Scheduler.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Use Default IoTWirelessClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-wireless/README.md Example of using the default IoTWirelessClient instance to list destinations. Requires Effect-TS. ```typescript import { IoTWireless } from "@effect-aws/client-iot-wireless"; const program = IoTWireless.listDestinations(args); const result = pipe( program, Effect.provide(IoTWireless.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Describe OpenSearch Domains with Custom Configuration Layer Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-opensearch/README.md Provide a custom layer with specific configuration options for the OpenSearchClient. This example uses `runPromiseExit` for handling the result. ```typescript import { OpenSearch } from "@effect-aws/client-opensearch"; const program = OpenSearch.describeDomains(args); const result = await pipe( program, Effect.provide(OpenSearch.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Use Custom STSClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-sts/README.md Example of using the STS client with a custom instance. Requires `Effect.provide` with `STS.baseLayer` and a `new STSClient` configuration. ```typescript import { STS } from "@effect-aws/client-sts"; const program = STS.getCallerIdentity(args); const result = await pipe( program, Effect.provide( STS.baseLayer(() => new STSClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### Use Custom IoTClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot/README.md This example shows how to use a custom IoTClient configuration with a specified region. It utilizes the `IoT.layer` function for configuration and `runPromiseExit` for execution. ```typescript import { IoT } from "@effect-aws/client-iot"; const program = IoT.describeJob(args); const result = await pipe( program, Effect.provide(IoT.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Use Default ECRClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ecr/README.md Example of using the ECR client with a default instance. Ensure ECR.defaultLayer is provided. ```typescript import { ECR } from "@effect-aws/client-ecr"; const program = ECR.describeRepositories(args); const result = pipe( program, Effect.provide(ECR.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Use Custom AutoScalingClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-auto-scaling/README.md Example of providing custom configuration to the AutoScaling client layer. This uses `runPromiseExit` for more control over the execution result. ```typescript import { AutoScaling } from "@effect-aws/client-auto-scaling"; const program = AutoScaling.describeAutoScalingGroups(args); const result = await pipe( program, Effect.provide(AutoScaling.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Use Default SSMClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ssm/README.md Example of using the SSM client with a default SSMClient instance. Ensure the necessary Effect.runPromise is called. ```typescript import { SSM } from "@effect-aws/client-ssm"; const program = SSM.describeParameters(args); const result = pipe( program, Effect.provide(SSM.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Use Default CloudFormationClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudformation/README.md Example of using the CloudFormation client with its default layer. This is suitable for most common use cases. ```typescript import { CloudFormation } from "@effect-aws/client-cloudformation"; const program = CloudFormation.listStacks(args); const result = pipe( program, Effect.provide(CloudFormation.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Use Default FirehoseClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-firehose/README.md Example of using the Firehose client with its default layer. Ensure the default layer is provided to the effect. ```typescript import { Firehose } from "@effect-aws/client-firehose"; const program = Firehose.putRecord(args); const result = pipe( program, Effect.provide(Firehose.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Start Command Execution with Custom Configuration Layer Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-jobs-data-plane/README.md Execute a command using a custom configuration layer for the IoTJobsDataPlaneClient. This method is suitable for providing specific client configurations. ```typescript import { IoTJobsDataPlane } from "@effect-aws/client-iot-jobs-data-plane"; const program = IoTJobsDataPlane.startCommandExecution(args); const result = await pipe( program, Effect.provide(IoTJobsDataPlane.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); or use `IoTJobsDataPlane.baseLayer((default) => new IoTJobsDataPlaneClient({ ...default, region: "eu-central-1" }))` ``` -------------------------------- ### Use Custom IoTEventsDataClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-events-data/README.md Example of providing a custom IoTEventsDataClient instance with a specific region. Useful for multi-region applications. ```typescript import { IoTEventsData } from "@effect-aws/client-iot-events-data"; const program = IoTEventsData.describeAlarm(args); const result = await pipe( program, Effect.provide( IoTEventsData.baseLayer(() => new IoTEventsDataClient({ region: "eu-central-1" })), ), Effect.runPromise, ); ``` -------------------------------- ### Use Default RDSClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-rds/README.md Example of using the RDS client with a default instance. Ensure the RDS client is provided to the effect runtime. ```typescript import { RDS } from "@effect-aws/client-rds"; const program = RDS.describeDBClusters(args); const result = pipe( program, Effect.provide(RDS.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Use Custom CloudFrontClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudfront/README.md Provide a custom CloudFrontClient instance, for example, by specifying a region. This allows for more control over the client's configuration. ```typescript import { CloudFront } from "@effect-aws/client-cloudfront"; const program = CloudFront.listCachePolicies(args); const result = await pipe( program, Effect.provide( CloudFront.baseLayer(() => new CloudFrontClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### List ECS Clusters with Custom Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ecs/README.md Configure the ECSClient with specific options like the AWS region using `ECS.layer`. This example uses `runPromiseExit`. ```typescript import { ECS } from "@effect-aws/client-ecs"; const program = ECS.listClusters(args); const result = await pipe( program, Effect.provide(ECS.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### List Trails with Custom Client Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudtrail/README.md Configure a custom CloudTrailClient with a specific region using `CloudTrail.layer`. This example uses `Effect.runPromiseExit`. ```typescript import { CloudTrail } from "@effect-aws/client-cloudtrail"; const program = CloudTrail.listTrails(args); const result = await pipe( program, Effect.provide(CloudTrail.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### List Kafka Connectors with Custom Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-kafkaconnect/README.md Configure the KafkaConnectClient with specific options, such as the region, using the KafkaConnect.layer function. This example uses Effect.runPromiseExit for execution. ```typescript import { KafkaConnect } from "@effect-aws/client-kafkaconnect"; const program = KafkaConnect.listConnectors(args); const result = await pipe( program, Effect.provide(KafkaConnect.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Use Custom SSMClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ssm/README.md Example of using the SSM client with a custom SSMClient configuration, specifying the region. Use Effect.runPromiseExit for execution. ```typescript import { SSM } from "@effect-aws/client-ssm"; const program = SSM.describeParameters(args); const result = await pipe( program, Effect.provide(SSM.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### List Kafka Clusters with Custom Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-kafka/README.md Configure the KafkaClient directly using Kafka.layer with specific region settings. This example uses Effect.runPromiseExit for handling the result. ```typescript import { Kafka } from "@effect-aws/client-kafka"; const program = Kafka.listClusters(args); const result = await pipe( program, Effect.provide(Kafka.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Post to Connection with Custom Client Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-api-gateway-management-api/README.md Provide custom configuration directly to the ApiGatewayManagementApi.layer function to create the client. This example uses Effect.runPromiseExit for execution. ```typescript import { ApiGatewayManagementApi } from "@effect-aws/client-api-gateway-management-api"; const program = ApiGatewayManagementApi.postToConnection(args); const result = await pipe( program, Effect.provide(ApiGatewayManagementApi.layer({ endpoint: "https://domain/path" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Use Custom CloudWatchClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudwatch/README.md This example demonstrates using a custom CloudWatchClient instance with a specified region. The `baseLayer` function allows for custom client instantiation. ```typescript import { CloudWatch } from "@effect-aws/client-cloudwatch"; const program = CloudWatch.describeAlarms(args); const result = await pipe( program, Effect.provide( CloudWatch.baseLayer(() => new CloudWatchClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### List ECS Clusters with Custom Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ecs/README.md Provide a custom ECSClient instance, specifying the AWS region. This example uses `await` for running the promise. ```typescript import { ECS } from "@effect-aws/client-ecs"; const program = ECS.listClusters(args); const result = await pipe( program, Effect.provide( ECS.baseLayer(() => new ECSClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### Use Custom SSMClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-ssm/README.md Example of using the SSM client with a custom SSMClient instance, specifying the region. The Effect.runPromise must be awaited. ```typescript import { SSM } from "@effect-aws/client-ssm"; const program = SSM.describeParameters(args); const result = await pipe( program, Effect.provide( SSM.baseLayer(() => new SSMClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### Use Default SecretsManagerClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-secrets-manager/README.md Example of using the SecretsManager client with its default instance. Ensure the necessary Effect runtime environment is provided. ```typescript import { SecretsManager } from "@effect-aws/client-secrets-manager"; const program = SecretsManager.getSecretValue(args); const result = pipe( program, Effect.provide(SecretsManager.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Describe CloudSearch Domains with Custom Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudsearch/README.md Configure the CloudSearchClient with specific options, such as the region, using the `CloudSearch.layer` function. This example uses `runPromiseExit` for execution. ```typescript import { CloudSearch } from "@effect-aws/client-cloudsearch"; const program = CloudSearch.describeDomains(args); const result = await pipe( program, Effect.provide(CloudSearch.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Publish with Custom IoTDataPlaneClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-iot-data-plane/README.md Provide custom configuration options, such as the AWS region, when creating the IoTDataPlaneClient layer. This example uses Effect.runPromiseExit. ```typescript import { IoTDataPlane } from "@effect-aws/client-iot-data-plane"; const program = IoTDataPlane.publish(args); const result = await pipe( program, Effect.provide(IoTDataPlane.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Describe Organization with Custom Configuration Layer Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-organizations/README.md Configure the OrganizationsClient using a layer with specific settings like region. This example uses `runPromiseExit` for handling effects. ```typescript import { Organizations } from "@effect-aws/client-organizations"; const program = Organizations.describeOrganization(args); const result = await pipe( program, Effect.provide(Organizations.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Use Custom SchedulerClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-scheduler/README.md This example shows how to provide custom configuration for the SchedulerClient, including the AWS region. It uses `runPromiseExit` for handling the effect's exit. ```typescript import { Scheduler } from "@effect-aws/client-scheduler"; const program = Scheduler.tagResource(args); const result = await pipe( program, Effect.provide(Scheduler.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); or use `Scheduler.baseLayer((default) => new SchedulerClient({ ...default, region: "eu-central-1" }))` ``` -------------------------------- ### Use Custom FirehoseClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-firehose/README.md Example of providing custom FirehoseClient configuration using the layer function. This allows for region-specific configurations and uses runPromiseExit. ```typescript import { Firehose } from "@effect-aws/client-firehose"; const program = Firehose.putRecord(args); const result = await pipe( program, Effect.provide(Firehose.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); or use `Firehose.baseLayer((default) => new FirehoseClient({ ...default, region: "eu-central-1" }))` ``` -------------------------------- ### List Trails with Custom Client Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudtrail/README.md Provide a custom CloudTrailClient instance, configured with a specific region, to list trails. This example uses `Effect.runPromise`. ```typescript import { CloudTrail } from "@effect-aws/client-cloudtrail"; const program = CloudTrail.listTrails(args); const result = await pipe( program, Effect.provide( CloudTrail.baseLayer(() => new CloudTrailClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### Use Custom BedrockClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-bedrock/README.md This example shows how to provide a custom BedrockClient configuration directly using the layer function. It also demonstrates using runPromiseExit for handling the Effect's exit. ```typescript import { Bedrock } from "@effect-aws/client-bedrock"; const program = Bedrock.listCustomModels(args); const result = await pipe( program, Effect.provide(Bedrock.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Get API with Default Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-api-gateway-v2/README.md Use the default ApiGatewayV2Client instance to get an API. Provide the default layer to the effect. ```typescript import { ApiGatewayV2 } from "@effect-aws/client-api-gateway-v2"; const program = ApiGatewayV2.getApi(args); const result = pipe( program, Effect.provide(ApiGatewayV2.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Get API Key with Default Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-api-gateway/README.md Use the default APIGatewayClient instance to get an API key. Ensure Effect's runPromise is used for execution. ```typescript import { APIGateway } from "@effect-aws/client-api-gateway"; const program = APIGateway.getApiKey(args); const result = pipe( program, Effect.provide(APIGateway.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Use Default CloudWatchClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudwatch/README.md This example shows how to use the CloudWatch client with its default layer. Ensure the default layer is provided to the program's effect context. ```typescript import { CloudWatch } from "@effect-aws/client-cloudwatch"; const program = CloudWatch.describeAlarms(args); const result = pipe( program, Effect.provide(CloudWatch.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### DynamoDB Put with Custom Layer Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/dynamodb/README.md Configure the DynamoDBDocument layer with custom marshalling options. This example uses `runPromiseExit`. ```typescript import { DynamoDBDocument } from "@effect-aws/dynamodb" const program = DynamoDBDocument.put(args) const result = await pipe( program, Effect.provide( DynamoDBDocument.layer({ marshallOptions: { removeUndefinedValues: true } }) ), Effect.runPromiseExit ) ``` -------------------------------- ### Use Custom TextractClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-textract/README.md Example of providing a custom TextractClient instance to the Effect-TS layer. Specify the AWS region. ```typescript import { Textract } from "@effect-aws/client-textract"; const program = Textract.listAdapters(args); const result = await pipe( program, Effect.provide( Textract.baseLayer(() => new TextractClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ``` -------------------------------- ### List Brokers with Default MqClient Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-mq/README.md Use the default MqClient instance to list brokers. Ensure Effect-TS is set up for running the program. ```typescript import { Mq } from "@effect-aws/client-mq"; const program = Mq.listBrokers(args); const result = pipe( program, Effect.provide(Mq.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Describe OpenSearch Domains with Default Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-opensearch/README.md Use the default OpenSearchClient instance to describe domains. Ensure the Effect-TS runtime is provided. ```typescript import { OpenSearch } from "@effect-aws/client-opensearch"; const program = OpenSearch.describeDomains(args); const result = pipe( program, Effect.provide(OpenSearch.defaultLayer), Effect.runPromise, ); ``` -------------------------------- ### Invoke Model with Custom Client Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-bedrock-runtime/README.md Configure the BedrockRuntimeClient with specific settings like region. This example uses `runPromiseExit`. ```typescript import { BedrockRuntime } from "@effect-aws/client-bedrock-runtime"; const program = BedrockRuntime.invokeModel(args); const result = await pipe( program, Effect.provide(BedrockRuntime.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Use Custom TextractClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-textract/README.md Example of configuring the Textract client directly within the Effect-TS layer. This method uses `runPromiseExit`. ```typescript import { Textract } from "@effect-aws/client-textract"; const program = Textract.listAdapters(args); const result = await pipe( program, Effect.provide(Textract.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### List Trails with Custom Client Configuration (Alternative) Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudtrail/README.md An alternative method to configure a custom CloudTrailClient using `CloudTrail.baseLayer` with merged default and custom configurations. ```typescript or use `CloudTrail.baseLayer((default) => new CloudTrailClient({ ...default, region: "eu-central-1" }))` ``` -------------------------------- ### Get API with Custom Client Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-api-gateway-v2/README.md Use a custom ApiGatewayV2Client instance with a specified region. Provide the base layer with a client factory function. ```typescript import { ApiGatewayV2 } from "@effect-aws/client-api-gateway-v2"; const program = ApiGatewayV2.getApi(args); const result = await pipe( program, Effect.provide( ApiGatewayV2.baseLayer(() => new ApiGatewayV2Client({ region: "eu-central-1" })), ), Effect.runPromise, ); ``` -------------------------------- ### List OpenSearch Serverless Collections with Custom Layer Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-opensearch-serverless/README.md Configure the OpenSearchServerless client layer with specific options like region. This example uses `runPromiseExit` for more detailed outcome handling. ```typescript import { OpenSearchServerless } from "@effect-aws/client-opensearch-serverless"; const program = OpenSearchServerless.listCollections(args); const result = await pipe( program, Effect.provide(OpenSearchServerless.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### List Regions with Custom AccountClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-account/README.md Configure the AccountClient with specific settings, such as the region, using Account.layer. This method provides a concise way to set up the client. ```typescript import { Account } from "@effect-aws/client-account"; const program = Account.listRegions(args); const result = await pipe( program, Effect.provide(Account.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Usage with Custom KMSClient Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-kms/README.md Configure the KMSClient with specific options like region. This example uses `runPromiseExit` for Effect's execution. ```typescript import { KMS } from "@effect-aws/client-kms"; const program = KMS.listKeys(args); const result = await pipe( program, Effect.provide(KMS.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### DynamoDB putItem with Custom Configuration Layer Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-dynamodb/README.md Configure the DynamoDBClient using a layer with specific settings, such as the region. This example uses `runPromiseExit` for execution. ```typescript import { DynamoDB } from "@effect-aws/client-dynamodb"; const program = DynamoDB.putItem(args); const result = await pipe( program, Effect.provide(DynamoDB.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Describe Log Groups with Custom Configuration Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-cloudwatch-logs/README.md Configure a custom CloudWatchLogsClient with a specific region using `CloudWatchLogs.layer`. This example uses `Effect.runPromiseExit` for execution. ```typescript import { CloudWatchLogs } from "@effect-aws/client-cloudwatch-logs"; const program = CloudWatchLogs.describeLogGroups(args); const result = await pipe( program, Effect.provide(CloudWatchLogs.layer({ region: "eu-central-1" })), Effect.runPromiseExit, ); ``` -------------------------------- ### Use Custom BedrockClient Instance Source: https://github.com/floydspace/effect-aws/blob/main/packages/client-bedrock/README.md This example demonstrates using a custom BedrockClient instance configured with a specific AWS region. The baseLayer function is used to provide this custom client. ```typescript import { Bedrock } from "@effect-aws/client-bedrock"; const program = Bedrock.listCustomModels(args); const result = await pipe( program, Effect.provide( Bedrock.baseLayer(() => new BedrockClient({ region: "eu-central-1" })) ), Effect.runPromise, ); ```