sf-aws-connect

A new CLI generated with oclif




- sf-aws-connect
- Usage
- Commands

Usage

``sh-session
$ npm install -g sf-aws-connect-dev
$ sf-aws-connect COMMAND
running command...
$ sf-aws-connect (--version)
sf-aws-connect/0.1.0 win32-x64 node-v20.16.0
$ sf-aws-connect --help [COMMAND]
USAGE
$ sf-aws-connect COMMAND
...
`

Commands

- sf-aws-connect download
- sf-aws-connect list-instances
- [sf-aws-connect help [COMMAND]](#sf-aws-connect-help-command)



sf-aws-connect download



Download components from AWS Connect

`
USAGE
$ sf-aws-connect download -i -c -o -r [-p | -k | -s ]
[--overrideFile] [-t ]

FLAGS
-c, --componentType= (required) Component type to download. Use "Comptype" for all, or "Comptype:Id" for
a single component.
Valid types:
all,
hoursOfOperation,
queues,
prompts,
contactFlows,
routingProfiles,
agentStatus,
lambdaFunctions
-i, --instanceId= (required) AWS Connect Instance ID
-k, --accessKeyId= AWS access key ID
-o, --outputDir= (required) Output path for the downloaded component(s)
-p, --profile= AWS profile for SSO
-r, --region= (required) [default: ap-southeast-2] AWS region
-s, --secretAccessKey= AWS secret access key
-t, --secretSessionToken= AWS token session key
--[no-]overWrite overWrite existing components

DESCRIPTION
Download components from AWS Connect

Download aws components from AWS Connect instance

EXAMPLES
$ sf-aws-connect download --instanceId 12345678-1234-1234-1234-123456789012 --componentType queues --outputPath ./downloads --region ap-southeast-2 --profile dev

$ sf-aws-connect download --instanceId 12345678-1234-1234-1234-123456789012 --componentType queues:abcdef-1234-5678-90ab-cdef12345678 --outputPath ./downloads --region ap-southeast-2 --accessKeyId YOUR_ACCESS_KEY --secretAccessKey YOUR_SECRET_KEY --secretSessionToken YOUR_SESSION_KEY
`

_See code: src/commands/download.ts_



sf-aws-connect help [COMMAND]



Display help for sf-aws-connect.

`
USAGE
$ sf-aws-connect help [COMMAND...] [-n]

ARGUMENTS
COMMAND... Command to show help for.

FLAGS
-n, --nested-commands Include all nested commands in the output.

DESCRIPTION
Display help for sf-aws-connect.
`

_See code: @oclif/plugin-help_



sf-aws-connect list-instances



List all AWS Connect instances

`
USAGE
$ sf-aws-connect list-instances [-p | -k | -s ] [-r ] [-t ]

FLAGS
-k, --accessKeyId= AWS access key ID
-p, --profile= AWS profile for SSO
-r, --region= [default: ap-southeast-2] AWS region
-s, --secretAccessKey= AWS secret access key
-t, --secretSessionToken= AWS token session key

DESCRIPTION
List all AWS Connect instances

This command lists all AWS Connect instances in the specified region

EXAMPLES
$ sf-aws-connect list-instances --region ap-southeast-2 --profile dev

$ sf-aws-connect list-instances --region ap-southeast-2 --accessKeyId YOUR_ACCESS_KEY --secretAccessKey YOUR_SECRET_KEY --secretSessionToken YOUR_SESSION_KEY
``

_See code: src/commands/list-instances.ts_