[ aws . alexaforbusiness ]

get-address-book

Description

Gets address the book details by the address book ARN.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-address-book
--address-book-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--address-book-arn (string)

The ARN of the address book for which to request details.

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

AddressBook -> (structure)

The details of the requested address book.

AddressBookArn -> (string)

The ARN of the address book.

Name -> (string)

The name of the address book.

Description -> (string)

The description of the address book.