[ aws . license-manager-user-subscriptions ]

associate-user

Description

Associates the user to an EC2 instance to utilize user-based subscriptions.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  associate-user
[--domain <value>]
--identity-provider <value>
--instance-id <value>
--username <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain (string)

The domain name of the user.

--identity-provider (structure)

The identity provider of the user.

ActiveDirectoryIdentityProvider -> (structure)

An object that details an Active Directory identity provider.

DirectoryId -> (string)

The directory ID for an Active Directory identity provider.

Shorthand Syntax:

ActiveDirectoryIdentityProvider={DirectoryId=string}

JSON Syntax:

{
  "ActiveDirectoryIdentityProvider": {
    "DirectoryId": "string"
  }
}

--instance-id (string)

The ID of the EC2 instance, which provides user-based subscriptions.

--username (string)

The user name from the identity provider for the user.

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

InstanceUserSummary -> (structure)

Metadata that describes the associate user operation.

AssociationDate -> (string)

The date a user was associated with an EC2 instance.

DisassociationDate -> (string)

The date a user was disassociated from an EC2 instance.

Domain -> (string)

The domain name of the user.

IdentityProvider -> (structure)

An object that specifies details for the identity provider.

ActiveDirectoryIdentityProvider -> (structure)

An object that details an Active Directory identity provider.

DirectoryId -> (string)

The directory ID for an Active Directory identity provider.

InstanceId -> (string)

The ID of the EC2 instance, which provides user-based subscriptions.

Status -> (string)

The status of a user associated with an EC2 instance.

StatusMessage -> (string)

The status message for users of an EC2 instance.

Username -> (string)

The user name from the identity provider for the user.