AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . rolesanywhere ]

create-profile

Description

Creates a profile , a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:CreateProfile .

See also: AWS API Documentation

Synopsis

  create-profile
[--duration-seconds <value>]
[--enabled | --no-enabled]
[--managed-policy-arns <value>]
--name <value>
[--require-instance-properties | --no-require-instance-properties]
--role-arns <value>
[--session-policy <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--duration-seconds (integer)

Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

--enabled | --no-enabled (boolean)

Specifies whether the profile is enabled.

--managed-policy-arns (list)

A list of managed policy ARNs that apply to the vended session credentials.

(string)

Syntax:

"string" "string" ...

--name (string)

The name of the profile.

--require-instance-properties | --no-require-instance-properties (boolean)

Specifies whether instance properties are required in temporary credential requests with this profile.

--role-arns (list)

A list of IAM roles that this profile can assume in a temporary credential request.

(string)

Syntax:

"string" "string" ...

--session-policy (string)

A session policy that applies to the trust boundary of the vended session credentials.

--tags (list)

The tags to attach to the profile.

(structure)

A label that consists of a key and value you define.

key -> (string)

The tag key.

value -> (string)

The tag value.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Output

profile -> (structure)

The state of the profile after a read or write operation.

attributeMappings -> (list)

A mapping applied to the authenticating end-entity certificate.

(structure)

A mapping applied to the authenticating end-entity certificate.

certificateField -> (string)

Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

mappingRules -> (list)

A list of mapping entries for every supported specifier or sub-field.

(structure)

A single mapping entry for each supported specifier or sub-field.

specifier -> (string)

Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

createdAt -> (timestamp)

The ISO-8601 timestamp when the profile was created.

createdBy -> (string)

The Amazon Web Services account that created the profile.

durationSeconds -> (integer)

Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

enabled -> (boolean)

Indicates whether the profile is enabled.

managedPolicyArns -> (list)

A list of managed policy ARNs that apply to the vended session credentials.

(string)

name -> (string)

The name of the profile.

profileArn -> (string)

The ARN of the profile.

profileId -> (string)

The unique identifier of the profile.

requireInstanceProperties -> (boolean)

Specifies whether instance properties are required in temporary credential requests with this profile.

roleArns -> (list)

A list of IAM roles that this profile can assume in a temporary credential request.

(string)

sessionPolicy -> (string)

A session policy that applies to the trust boundary of the vended session credentials.

updatedAt -> (timestamp)

The ISO-8601 timestamp when the profile was last updated.