[ aws . alexaforbusiness ]

create-contact

Description

Creates a contact with the specified details.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-contact
[--display-name <value>]
--first-name <value>
[--last-name <value>]
[--phone-number <value>]
[--phone-numbers <value>]
[--sip-addresses <value>]
[--client-request-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--display-name (string)

The name of the contact to display on the console.

--first-name (string)

The first name of the contact that is used to call the contact on the device.

--last-name (string)

The last name of the contact that is used to call the contact on the device.

--phone-number (string)

The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

--phone-numbers (list)

The list of phone numbers for the contact.

Shorthand Syntax:

Number=string,Type=string ...

JSON Syntax:

[
  {
    "Number": "string",
    "Type": "MOBILE"|"WORK"|"HOME"
  }
  ...
]

--sip-addresses (list)

The list of SIP addresses for the contact.

Shorthand Syntax:

Uri=string,Type=string ...

JSON Syntax:

[
  {
    "Uri": "string",
    "Type": "WORK"
  }
  ...
]

--client-request-token (string)

A unique, user-specified identifier for this request that ensures idempotency.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ContactArn -> (string)

The ARN of the newly created address book.