create-account-assignment¶
Description¶
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
Note
The term principal here refers to a user or group that is defined in Amazon Web Services SSO.
Note
As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in Amazon Web Services SSO. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call `` ProvisionPermissionSet `` to make these updates.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-account-assignment
--instance-arn <value>
--target-id <value>
--target-type <value>
--permission-set-arn <value>
--principal-type <value>
--principal-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--instance-arn (string)
The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .
--target-id (string)
TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
--target-type (string)
The entity type for which the assignment will be created.
Possible values:
AWS_ACCOUNT
--permission-set-arn (string)
The ARN of the permission set that the admin wants to grant the principal access to.
--principal-type (string)
The entity type for which the assignment will be created.
Possible values:
USER
GROUP
--principal-id (string)
An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
AccountAssignmentCreationStatus -> (structure)
The status object for the account assignment creation operation.
Status -> (string)
The status of the permission set provisioning process.
RequestId -> (string)
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
FailureReason -> (string)
The message that contains an error or exception in case of an operation failure.
TargetId -> (string)
TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
TargetType -> (string)
The entity type for which the assignment will be created.
PermissionSetArn -> (string)
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .
PrincipalType -> (string)
The entity type for which the assignment will be created.
PrincipalId -> (string)
An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .
CreatedDate -> (timestamp)
The date that the permission set was created.