[ aws . connect ]

list-contact-references

Description

This API is in preview release for Amazon Connect and is subject to change.

For the specified referenceTypes , returns a list of references associated with the contact.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-contact-references is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ReferenceSummaryList

Synopsis

  list-contact-references
--instance-id <value>
--contact-id <value>
--reference-types <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--contact-id (string)

The identifier of the initial contact.

--reference-types (list)

The type of reference.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  URL
  ATTACHMENT
  NUMBER
  STRING
  DATE
  EMAIL

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

ReferenceSummaryList -> (list)

Information about the contact flows.

(structure)

Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

Url -> (structure)

Information about the reference when the referenceType is URL . Otherwise, null.

Name -> (string)

Identifier of the URL reference.

Value -> (string)

A valid URL.

Attachment -> (structure)

Information about the reference when the referenceType is ATTACHMENT . Otherwise, null.

Name -> (string)

Identifier of the attachment reference.

Value -> (string)

The location path of the attachment reference.

Status -> (string)

Status of the attachment reference type.

String -> (structure)

Information about a reference when the referenceType is STRING . Otherwise, null.

Name -> (string)

Identifier of the string reference.

Value -> (string)

A valid string.

Number -> (structure)

Information about a reference when the referenceType is NUMBER . Otherwise, null.

Name -> (string)

Identifier of the number reference.

Value -> (string)

A valid number.

Date -> (structure)

Information about a reference when the referenceType is DATE . Otherwise, null.

Name -> (string)

Identifier of the date reference.

Value -> (string)

A valid date.

Email -> (structure)

Information about a reference when the referenceType is EMAIL . Otherwise, null.

Name -> (string)

Identifier of the email reference.

Value -> (string)

A valid email address.

NextToken -> (string)

If there are additional results, this is the token for the next set of results.

Warning

This is always returned as null in the response.