[ aws . workspaces ]

describe-connect-client-add-ins

Description

Retrieves a list of Amazon Connect client add-ins that have been created.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-connect-client-add-ins
--resource-id <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--resource-id (string)

The directory identifier for which the client add-in is configured.

--next-token (string)

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

--max-results (integer)

The maximum number of items to return.

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

AddIns -> (list)

Information about client add-ins.

(structure)

Describes an Amazon Connect client add-in.

AddInId -> (string)

The client add-in identifier.

ResourceId -> (string)

The directory identifier for which the client add-in is configured.

Name -> (string)

The name of the client add in.

URL -> (string)

The endpoint URL of the client add-in.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.