[ aws . configure ]

export-credentials

Description

Export credentials in various formats. This command will retrieve AWS credentials using the AWS CLI’s credential resolution process and display the credentials in the specified --format. By default, the output format is process, which is a JSON format that’s expected by the credential process feature supported by the AWS SDKs and Tools. This command ignores the global --query and --output options.

Synopsis

aws configure export-credentials --profile profile-name

Options

--format (string) The output format to display credentials. Defaults to process.

• process - Display credentials as JSON output, in the schema expected by the credential_process config value.This enables any library or tool that supports credential_process to use the AWS CLI’s credential resolution process: credential_process = aws configure export-credentials --profile myprofile
• env - Display credentials as exported shell variables: export AWS_ACCESS_KEY_ID=EXAMPLE
• env-no-export - Display credentials as non-exported shell variables: AWS_ACCESS_KEY_ID=EXAMPLE
• powershell - Display credentials as PowerShell environment variables: $Env:AWS_ACCESS_KEY_ID="EXAMPLE"
• windows-cmd - Display credentials as Windows cmd environment variables: set AWS_ACCESS_KEY_ID=EXAMPLE

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.