# get-role-credentials ## Description Returns temporary Amazon Web Services credentials for a role that you are entitled to assume within a tenant. You can use these credentials for programmatic access with the CLI or an Amazon Web Services SDK. If you aren’t entitled to the role, the request fails with an `AccessDeniedException` error. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/account-access-runtime-2018-05-10/GetRoleCredentials) ## Synopsis ``` get-role-credentials --tenant-id --role-arn --access-type [--session-name ] [--session-duration ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] [--help] ``` ## Options `--tenant-id` (string) [required] > The identifier of the tenant that the request applies to. A tenant ID begins with `aa-` and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens. > Constraints: > * min: `3` > * max: `24` > * pattern: `[a-z0-9-]+` `--role-arn` (string) [required] > The Amazon Resource Name (ARN) of the role to retrieve credentials for. You must be entitled to assume this role. `--access-type` (string) [required] > The type of access to request for the role. Specify `PROGRAMMATIC_ACCESS` to receive access key credentials for use with the CLI or an Amazon Web Services SDK. > Possible values: > * `PROGRAMMATIC_ACCESS` `--session-name` (string) > An optional name for the role session. The name can be 2 to 64 characters and can contain alphanumeric characters and the following symbols: plus (+), equal (=), comma (,), period (.), at (@), and hyphen (-). The session name appears in CloudTrail logs for the assumed role session. > Constraints: > * pattern: `[a-zA-Z0-9_+=,.@-]{2,64}` `--session-duration` (integer) > The duration, in seconds, that the returned credentials remain valid. If you don’t specify a value, the service uses the default session duration. The maximum value can’t exceed the maximum session duration configured for the role. `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. `--generate-cli-skeleton` (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## 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 * off `--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. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced `--help` (boolean) Display help for the command/subcommand. ## Output credentialsDetails -> (tagged union structure) > The temporary credentials that the service returns for the requested role. > #### NOTE > This is a Tagged Union structure. Only one of the following top level keys can be set: `programmaticAccess`. > programmaticAccess -> (structure) > > The access key credentials returned for programmatic access with the CLI or an Amazon Web Services SDK. > > accessKeyId -> (string) [required] > > > The access key ID for the temporary credentials. > > secretAccessKey -> (string) [required] > > > The secret access key for the temporary credentials. Treat this value as a secret. > > sessionToken -> (string) [required] > > > The session token that you must include along with the access key ID and secret access key when you make requests with the temporary credentials. > > expiresAt -> (timestamp) [required] > > > The date and time when the temporary credentials expire, after which they can no longer be used.