[ aws . chime-sdk-identity ]

create-app-instance-user

Description

Creates a user under an Amazon Chime AppInstance . The request consists of a unique appInstanceUserId and Name for that user.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-app-instance-user
--app-instance-arn <value>
--app-instance-user-id <value>
--name <value>
[--metadata <value>]
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-instance-arn (string)

The ARN of the AppInstance request.

--app-instance-user-id (string)

The user ID of the AppInstance .

--name (string)

The user’s name.

--metadata (string)

The request’s metadata. Limited to a 1KB string in UTF-8.

--client-request-token (string)

The token assigned to the user requesting an AppInstance .

--tags (list)

Tags assigned to the AppInstanceUser .

(structure)

A tag object containing a key-value pair.

Key -> (string)

The key in a tag.

Value -> (string)

The value in a tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

See ‘aws help’ for descriptions of global parameters.

Output

AppInstanceUserArn -> (string)

The user’s ARN.