Command-Line Reference#

usage: paws [-h] {session-profile,long-term-profile} ...

Positional Arguments#

command

Possible choices: session-profile, long-term-profile

command

Sub-commands#

session-profile#

AWS Session credential (ASIA) CLI profile management

paws session-profile [-h] [--from PROFILE] [--mfa-token-code CODE] [--force-session-renewal] [--output-format {pwsh-environ,posix-environ,json,ini}]
                     [--configure] [--write-fs-config FILE] [--write-fs-shared-credentials FILE] [--log-level {NOTSET,DEBUG,INFO,WARNING,ERROR,CRITICAL}]
                     [--quick] [--stdin]
                     [name]

Positional Arguments#

name

name of (filesystem) profile

Default: “default”

Named Arguments#

--from, -s

name of a long-term profile (or session profile) to create (or update) this session profile from

--mfa-token-code, -a

token code of –from virtual MFA device to authenticate with

--force-session-renewal, -f

force a new session, regardless of whether the configuration is sufficient

Default: False

--output-format, -d

Possible choices: pwsh-environ, posix-environ, json, ini

output format for STDOUT

Default: “ini”

--configure, -c

adjust session profile interactively before writing output

Default: False

--write-fs-config, -m

write config partials output to a file

--write-fs-shared-credentials, -n

write shared credentials partials output to a file

--log-level, -l

Possible choices: NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAL

set log level

Default: “ERROR”

--quick, -q

skip prompts for defaults and optional properties

Default: False

--stdin, -i

read from STDIN whole (as opposed to interactive line-by-line prompt), combine with –configure

Default: False

long-term-profile#

AWS Long-term credential (AKIA) CLI profile management

paws long-term-profile [-h] [--output-format {pwsh-environ,posix-environ,json,ini}] [--configure] [--write-fs-config FILE]
                       [--write-fs-shared-credentials FILE] [--log-level {NOTSET,DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--quick] [--stdin]
                       [name]

Positional Arguments#

name

name of (filesystem) profile

Default: “default”

Named Arguments#

--output-format, -d

Possible choices: pwsh-environ, posix-environ, json, ini

output format for STDOUT

Default: “ini”

--configure, -c

adjust session profile interactively before writing output

Default: False

--write-fs-config, -m

write config partials output to a file

--write-fs-shared-credentials, -n

write shared credentials partials output to a file

--log-level, -l

Possible choices: NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAL

set log level

Default: “ERROR”

--quick, -q

skip prompts for defaults and optional properties

Default: False

--stdin, -i

read from STDIN whole (as opposed to interactive line-by-line prompt), combine with –configure

Default: False