Class: AWS.Connect

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  TargetAccountId: 'STRING_VALUE'
};
connect.associateAnalyticsDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • DataSetId — (String)

    The identifier of the dataset to associate with the target account.

  • TargetAccountId — (String)

    The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DataSetId — (String)

      The identifier of the dataset that was associated.

    • TargetAccountId — (String)

      The identifier of the target account.

    • ResourceShareId — (String)

      The Resource Access Manager share ID that is generated.

    • ResourceShareArn — (String)

      The Amazon Resource Name (ARN) of the Resource Access Manager share.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Origin: 'STRING_VALUE' /* required */
};
connect.associateApprovedOrigin(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Origin — (String)

    The domain to add to your allow list.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LexBot: {
    LexRegion: 'STRING_VALUE', /* required */
    Name: 'STRING_VALUE' /* required */
  },
  LexV2Bot: {
    AliasArn: 'STRING_VALUE'
  }
};
connect.associateBot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • LexBot — (map)

    Configuration information of an Amazon Lex bot.

    • Name — required — (String)

      The name of the Amazon Lex bot.

    • LexRegion — required — (String)

      The Amazon Web Services Region where the Amazon Lex bot was created.

  • LexV2Bot — (map)

    The Amazon Lex V2 bot to associate with the instance.

    • AliasArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LanguageCode: ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN | en-NZ | en-ZA | ca-ES | da-DK | fi-FI | id-ID | ms-MY | nl-NL | no-NO | pl-PL | sv-SE | tl-PH, /* required */
  VocabularyId: 'STRING_VALUE'
};
connect.associateDefaultVocabulary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • LanguageCode — (String)

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

    Possible values include:
    • "ar-AE"
    • "de-CH"
    • "de-DE"
    • "en-AB"
    • "en-AU"
    • "en-GB"
    • "en-IE"
    • "en-IN"
    • "en-US"
    • "en-WL"
    • "es-ES"
    • "es-US"
    • "fr-CA"
    • "fr-FR"
    • "hi-IN"
    • "it-IT"
    • "ja-JP"
    • "ko-KR"
    • "pt-BR"
    • "pt-PT"
    • "zh-CN"
    • "en-NZ"
    • "en-ZA"
    • "ca-ES"
    • "da-DK"
    • "fi-FI"
    • "id-ID"
    • "ms-MY"
    • "nl-NL"
    • "no-NO"
    • "pl-PL"
    • "sv-SE"
    • "tl-PH"
  • VocabularyId — (String)

    The identifier of the custom vocabulary. If this is empty, the default is set to none.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  FlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: SMS_PHONE_NUMBER /* required */
};
connect.associateFlow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ResourceId — (String)

    The identifier of the resource.

  • FlowId — (String)

    The identifier of the flow.

  • ResourceType — (String)

    A valid resource type.

    Possible values include:
    • "SMS_PHONE_NUMBER"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ResourceType: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS, /* required */
  StorageConfig: { /* required */
    StorageType: S3 | KINESIS_VIDEO_STREAM | KINESIS_STREAM | KINESIS_FIREHOSE, /* required */
    AssociationId: 'STRING_VALUE',
    KinesisFirehoseConfig: {
      FirehoseArn: 'STRING_VALUE' /* required */
    },
    KinesisStreamConfig: {
      StreamArn: 'STRING_VALUE' /* required */
    },
    KinesisVideoStreamConfig: {
      EncryptionConfig: { /* required */
        EncryptionType: KMS, /* required */
        KeyId: 'STRING_VALUE' /* required */
      },
      Prefix: 'STRING_VALUE', /* required */
      RetentionPeriodHours: 'NUMBER_VALUE' /* required */
    },
    S3Config: {
      BucketName: 'STRING_VALUE', /* required */
      BucketPrefix: 'STRING_VALUE', /* required */
      EncryptionConfig: {
        EncryptionType: KMS, /* required */
        KeyId: 'STRING_VALUE' /* required */
      }
    }
  }
};
connect.associateInstanceStorageConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ResourceType — (String)

    A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:

    • For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.

    • For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.

    Note: REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward. If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
    Possible values include:
    • "CHAT_TRANSCRIPTS"
    • "CALL_RECORDINGS"
    • "SCHEDULED_REPORTS"
    • "MEDIA_STREAMS"
    • "CONTACT_TRACE_RECORDS"
    • "AGENT_EVENTS"
    • "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS"
    • "ATTACHMENTS"
    • "CONTACT_EVALUATIONS"
    • "SCREEN_RECORDINGS"
    • "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS"
    • "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS"
  • StorageConfig — (map)

    A valid storage type.

    • AssociationId — (String)

      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

    • StorageType — required — (String)

      A valid storage type.

      Possible values include:
      • "S3"
      • "KINESIS_VIDEO_STREAM"
      • "KINESIS_STREAM"
      • "KINESIS_FIREHOSE"
    • S3Config — (map)

      The S3 bucket configuration.

      • BucketName — required — (String)

        The S3 bucket name.

      • BucketPrefix — required — (String)

        The S3 bucket prefix.

      • EncryptionConfig — (map)

        The Amazon S3 encryption configuration.

        • EncryptionType — required — (String)

          The type of encryption.

          Possible values include:
          • "KMS"
        • KeyId — required — (String)

          The full ARN of the encryption key.

          Note: Be sure to provide the full ARN of the encryption key, not just the ID. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
    • KinesisVideoStreamConfig — (map)

      The configuration of the Kinesis video stream.

      • Prefix — required — (String)

        The prefix of the video stream.

      • RetentionPeriodHours — required — (Integer)

        The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

        The default value is 0, indicating that the stream does not persist data.

      • EncryptionConfig — required — (map)

        The encryption configuration.

        • EncryptionType — required — (String)

          The type of encryption.

          Possible values include:
          • "KMS"
        • KeyId — required — (String)

          The full ARN of the encryption key.

          Note: Be sure to provide the full ARN of the encryption key, not just the ID. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
    • KinesisStreamConfig — (map)

      The configuration of the Kinesis data stream.

      • StreamArn — required — (String)

        The Amazon Resource Name (ARN) of the data stream.

    • KinesisFirehoseConfig — (map)

      The configuration of the Kinesis Firehose delivery stream.

      • FirehoseArn — required — (String)

        The Amazon Resource Name (ARN) of the delivery stream.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AssociationId — (String)

      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  FunctionArn: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.associateLambdaFunction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • FunctionArn — (String)

    The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LexBot: { /* required */
    LexRegion: 'STRING_VALUE', /* required */
    Name: 'STRING_VALUE' /* required */
  }
};
connect.associateLexBot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • LexBot — (map)

    The Amazon Lex bot to associate with the instance.

    • Name — required — (String)

      The name of the Amazon Lex bot.

    • LexRegion — required — (String)

      The Amazon Web Services Region where the Amazon Lex bot was created.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  PhoneNumberId: 'STRING_VALUE' /* required */
};
connect.associatePhoneNumberContactFlow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • PhoneNumberId — (String)

    A unique identifier for the phone number.

  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactFlowId — (String)

    The identifier of the flow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE', /* required */
  QuickConnectIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
connect.associateQueueQuickConnects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • QueueId — (String)

    The identifier for the queue.

  • QuickConnectIds — (Array<String>)

    The quick connects to associate with this queue.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueConfigs: [ /* required */
    {
      Delay: 'NUMBER_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      QueueReference: { /* required */
        Channel: VOICE | CHAT | TASK, /* required */
        QueueId: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  RoutingProfileId: 'STRING_VALUE' /* required */
};
connect.associateRoutingProfileQueues(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • RoutingProfileId — (String)

    The identifier of the routing profile.

  • QueueConfigs — (Array<map>)

    The queues to associate with this routing profile.

    • QueueReference — required — (map)

      Contains information about a queue resource.

      • QueueId — required — (String)

        The identifier for the queue.

      • Channel — required — (String)

        The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

        Possible values include:
        • "VOICE"
        • "CHAT"
        • "TASK"
    • Priority — required — (Integer)

      The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

    • Delay — required — (Integer)

      The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE' /* required */
};
connect.associateSecurityKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Key — (String)

    A valid security key in PEM format as a String.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AssociationId — (String)

      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  TrafficDistributionGroupId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
connect.associateTrafficDistributionGroupUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TrafficDistributionGroupId — (String)

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

  • UserId — (String)

    The identifier of the user account. This can be the ID or the ARN of the user.

  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  UserProficiencies: [ /* required */
    {
      AttributeName: 'STRING_VALUE', /* required */
      AttributeValue: 'STRING_VALUE', /* required */
      Level: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ]
};
connect.associateUserProficiencies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).

  • UserId — (String)

    The identifier of the user account.

  • UserProficiencies — (Array<map>)

    The proficiencies to associate with the user.

    • AttributeName — required — (String)

      The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance.

    • AttributeValue — required — (String)

      The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance.

    • Level — required — (Float)

      The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DataSetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  TargetAccountId: 'STRING_VALUE'
};
connect.batchAssociateAnalyticsDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • DataSetIds — (Array<String>)

    An array of dataset identifiers to associate.

  • TargetAccountId — (String)

    The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Created — (Array<map>)

      Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.

      • DataSetId — (String)

        The identifier of the dataset.

      • TargetAccountId — (String)

        The identifier of the target account.

      • ResourceShareId — (String)

        The Resource Access Manager share ID.

      • ResourceShareArn — (String)

        The Amazon Resource Name (ARN) of the Resource Access Manager share.

    • Errors — (Array<map>)

      A list of errors for datasets that aren't successfully associated with the target account.

      • ErrorCode — (String)

        The error code.

      • ErrorMessage — (String)

        The corresponding error message for the error code.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DataSetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  TargetAccountId: 'STRING_VALUE'
};
connect.batchDisassociateAnalyticsDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • DataSetIds — (Array<String>)

    An array of associated dataset identifiers to remove.

  • TargetAccountId — (String)

    The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Deleted — (Array<String>)

      An array of successfully disassociated dataset identifiers.

    • Errors — (Array<map>)

      A list of errors for any datasets not successfully removed.

      • ErrorCode — (String)

        The error code.

      • ErrorMessage — (String)

        The corresponding error message for the error code.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AssociatedResourceArn: 'STRING_VALUE', /* required */
  FileIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  InstanceId: 'STRING_VALUE' /* required */
};
connect.batchGetAttachedFileMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • FileIds — (Array<String>)

    The unique identifiers of the attached file resource.

  • InstanceId — (String)

    The unique identifier of the Connect instance.

  • AssociatedResourceArn — (String)

    The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

    Note: This value must be a valid ARN.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Files — (Array<map>)

      List of attached files that were successfully retrieved.

      • CreationTime — required — (String)

        The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

      • FileArn — required — (String)

        The unique identifier of the attached file resource (ARN).

      • FileId — required — (String)

        The unique identifier of the attached file resource.

      • FileName — required — (String)

        A case-sensitive name of the attached file being uploaded.

      • FileSizeInBytes — required — (Integer)

        The size of the attached file in bytes.

      • FileStatus — required — (String)

        The current status of the attached file.

        Possible values include:
        • "APPROVED"
        • "REJECTED"
        • "PROCESSING"
        • "FAILED"
      • CreatedBy — (map)

        Represents the identity that created the file.

        • ConnectUserArn — (String)

          An agent ARN representing a connect user.

        • AWSIdentityArn — (String)

          STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

      • FileUseCaseType — (String)

        The use case for the file.

        Possible values include:
        • "ATTACHMENT"
      • AssociatedResourceArn — (String)

        The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

        Note: This value must be a valid ARN.
      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

    • Errors — (Array<map>)

      List of errors of attached files that could not be retrieved.

      • ErrorCode — (String)

        Status code describing the failure.

      • ErrorMessage — (String)

        Why the attached file couldn't be retrieved.

      • FileId — (String)

        The unique identifier of the attached file resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ResourceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ResourceType: VOICE_PHONE_NUMBER
};
connect.batchGetFlowAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ResourceIds — (Array<String>)

    A list of resource identifiers to retrieve flow associations.

  • ResourceType — (String)

    The type of resource association.

    Possible values include:
    • "VOICE_PHONE_NUMBER"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • FlowAssociationSummaryList — (Array<map>)

      Information about flow associations.

      • ResourceId — (String)

        The identifier of the resource.

      • FlowId — (String)

        The identifier of the flow.

      • ResourceType — (String)

        The type of resource association.

        Possible values include:
        • "VOICE_PHONE_NUMBER"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ContactDataRequestList: [ /* required */
    {
      Attributes: {
        '<AttributeName>': 'STRING_VALUE',
        /* '<AttributeName>': ... */
      },
      Campaign: {
        CampaignId: 'STRING_VALUE'
      },
      CustomerEndpoint: {
        Address: 'STRING_VALUE',
        Type: TELEPHONE_NUMBER | VOIP | CONTACT_FLOW
      },
      QueueId: 'STRING_VALUE',
      RequestIdentifier: 'STRING_VALUE',
      SystemEndpoint: {
        Address: 'STRING_VALUE',
        Type: TELEPHONE_NUMBER | VOIP | CONTACT_FLOW
      }
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connect.batchPutContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    If a token is not provided, the SDK will use a version 4 UUID.
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactDataRequestList — (Array<map>)

    List of individual contact requests.

    • SystemEndpoint — (map)

      Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign.

      • Type — (String)

        Type of the endpoint.

        Possible values include:
        • "TELEPHONE_NUMBER"
        • "VOIP"
        • "CONTACT_FLOW"
      • Address — (String)

        Address of the endpoint.

    • CustomerEndpoint — (map)

      Endpoint of the customer for which contact will be initiated.

      • Type — (String)

        Type of the endpoint.

        Possible values include:
        • "TELEPHONE_NUMBER"
        • "VOIP"
        • "CONTACT_FLOW"
      • Address — (String)

        Address of the endpoint.

    • RequestIdentifier — (String)

      Identifier to uniquely identify individual requests in the batch.

    • QueueId — (String)

      The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued.

    • Attributes — (map<String>)

      List of attributes to be stored in a contact.

    • Campaign — (map)

      Structure to store information associated with a campaign.

      • CampaignId — (String)

        A unique identifier for a campaign.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SuccessfulRequestList — (Array<map>)

      List of requests for which contact was successfully created.

      • RequestIdentifier — (String)

        Request identifier provided in the API call in the ContactDataRequest to create a contact.

      • ContactId — (String)

        The contactId of the contact that was created successfully.

    • FailedRequestList — (Array<map>)

      List of requests for which contact creation failed.

      • RequestIdentifier — (String)

        Request identifier provided in the API call in the ContactDataRequest to create a contact.

      • FailureReasonCode — (String)

        Reason code for the failure.

        Possible values include:
        • "INVALID_ATTRIBUTE_KEY"
        • "INVALID_CUSTOMER_ENDPOINT"
        • "INVALID_SYSTEM_ENDPOINT"
        • "INVALID_QUEUE"
        • "MISSING_CAMPAIGN"
        • "MISSING_CUSTOMER_ENDPOINT"
        • "MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT"
        • "REQUEST_THROTTLED"
        • "IDEMPOTENCY_EXCEPTION"
        • "INTERNAL_ERROR"
      • FailureReasonMessage — (String)

        Why the request to create a contact failed.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  PhoneNumber: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  PhoneNumberDescription: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  TargetArn: 'STRING_VALUE'
};
connect.claimPhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TargetArn — (String)

    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

  • InstanceId — (String)

    The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

  • PhoneNumber — (String)

    The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

  • PhoneNumberDescription — (String)

    The description of the phone number.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PhoneNumberId — (String)

      A unique identifier for the phone number.

    • PhoneNumberArn — (String)

      The Amazon Resource Name (ARN) of the phone number.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AssociatedResourceArn: 'STRING_VALUE', /* required */
  FileId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.completeAttachedFileUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The unique identifier of the Amazon Connect instance.

  • FileId — (String)

    The unique identifier of the attached file resource.

  • AssociatedResourceArn — (String)

    The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

    Note: This value must be a valid ARN.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  State: ENABLED | DISABLED, /* required */
  Description: 'STRING_VALUE',
  DisplayOrder: 'NUMBER_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createAgentStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name — (String)

    The name of the status.

  • Description — (String)

    The description of the status.

  • State — (String)

    The state of the status.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • DisplayOrder — (Integer)

    The display order of the status.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AgentStatusARN — (String)

      The Amazon Resource Name (ARN) of the agent status.

    • AgentStatusId — (String)

      The identifier of the agent status.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Content: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Type: CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER | AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER | QUEUE_TRANSFER, /* required */
  Description: 'STRING_VALUE',
  Status: PUBLISHED | SAVED,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createContactFlow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance.

  • Name — (String)

    The name of the flow.

  • Type — (String)

    The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

    Possible values include:
    • "CONTACT_FLOW"
    • "CUSTOMER_QUEUE"
    • "CUSTOMER_HOLD"
    • "CUSTOMER_WHISPER"
    • "AGENT_HOLD"
    • "AGENT_WHISPER"
    • "OUTBOUND_WHISPER"
    • "AGENT_TRANSFER"
    • "QUEUE_TRANSFER"
  • Description — (String)

    The description of the flow.

  • Content — (String)

    The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

    Length Constraints: Minimum length of 1. Maximum length of 256000.

  • Status — (String)

    Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.

    Possible values include:
    • "PUBLISHED"
    • "SAVED"
  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ContactFlowId — (String)

      The identifier of the flow.

    • ContactFlowArn — (String)

      The Amazon Resource Name (ARN) of the flow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Content: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createContactFlowModule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name — (String)

    The name of the flow module.

  • Description — (String)

    The description of the flow module.

  • Content — (String)

    The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Id — (String)

      The identifier of the flow module.

    • Arn — (String)

      The Amazon Resource Name (ARN) of the flow module.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Items: [ /* EvaluationFormItemsList */ /* required */
    {
      Question: {
        QuestionType: TEXT | SINGLESELECT | NUMERIC, /* required */
        RefId: 'STRING_VALUE', /* required */
        Title: 'STRING_VALUE', /* required */
        Instructions: 'STRING_VALUE',
        NotApplicableEnabled: true || false,
        QuestionTypeProperties: {
          Numeric: {
            MaxValue: 'NUMBER_VALUE', /* required */
            MinValue: 'NUMBER_VALUE', /* required */
            Automation: {
              PropertyValue: {
                Label: OVERALL_CUSTOMER_SENTIMENT_SCORE | OVERALL_AGENT_SENTIMENT_SCORE | NON_TALK_TIME | NON_TALK_TIME_PERCENTAGE | NUMBER_OF_INTERRUPTIONS | CONTACT_DURATION | AGENT_INTERACTION_DURATION | CUSTOMER_HOLD_TIME /* required */
              }
            },
            Options: [
              {
                MaxValue: 'NUMBER_VALUE', /* required */
                MinValue: 'NUMBER_VALUE', /* required */
                AutomaticFail: true || false,
                Score: 'NUMBER_VALUE'
              },
              /* more items */
            ]
          },
          SingleSelect: {
            Options: [ /* required */
              {
                RefId: 'STRING_VALUE', /* required */
                Text: 'STRING_VALUE', /* required */
                AutomaticFail: true || false,
                Score: 'NUMBER_VALUE'
              },
              /* more items */
            ],
            Automation: {
              Options: [ /* required */
                {
                  RuleCategory: {
                    Category: 'STRING_VALUE', /* required */
                    Condition: PRESENT | NOT_PRESENT, /* required */
                    OptionRefId: 'STRING_VALUE' /* required */
                  }
                },
                /* more items */
              ],
              DefaultOptionRefId: 'STRING_VALUE'
            },
            DisplayAs: DROPDOWN | RADIO
          }
        },
        Weight: 'NUMBER_VALUE'
      },
      Section: {
        Items: /* recursive EvaluationFormItemsList */,
        RefId: 'STRING_VALUE', /* required */
        Title: 'STRING_VALUE', /* required */
        Instructions: 'STRING_VALUE',
        Weight: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ],
  Title: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ScoringStrategy: {
    Mode: QUESTION_ONLY | SECTION_ONLY, /* required */
    Status: ENABLED | DISABLED /* required */
  }
};
connect.createEvaluationForm(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Title — (String)

    A title of the evaluation form.

  • Description — (String)

    The description of the evaluation form.

  • Items — (Array<map>)

    Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

    • Section — (map)

      The information of the section.

      • Title — required — (String)

        The title of the section.

      • RefId — required — (String)

        The identifier of the section. An identifier must be unique within the evaluation form.

      • Instructions — (String)

        The instructions of the section.

      • Items — required — (Array<map>)

        The items of the section.

      • Weight — (Float)

        The scoring weight of the section.

    • Question — (map)

      The information of the question.

      • Title — required — (String)

        The title of the question.

      • Instructions — (String)

        The instructions of the section.

      • RefId — required — (String)

        The identifier of the question. An identifier must be unique within the evaluation form.

      • NotApplicableEnabled — (Boolean)

        The flag to enable not applicable answers to the question.

      • QuestionType — required — (String)

        The type of the question.

        Possible values include:
        • "TEXT"
        • "SINGLESELECT"
        • "NUMERIC"
      • QuestionTypeProperties — (map)

        The properties of the type of question. Text questions do not have to define question type properties.

        • Numeric — (map)

          The properties of the numeric question.

          • MinValue — required — (Integer)

            The minimum answer value.

          • MaxValue — required — (Integer)

            The maximum answer value.

          • Options — (Array<map>)

            The scoring options of the numeric question.

            • MinValue — required — (Integer)

              The minimum answer value of the range option.

            • MaxValue — required — (Integer)

              The maximum answer value of the range option.

            • Score — (Integer)

              The score assigned to answer values within the range option.

            • AutomaticFail — (Boolean)

              The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

          • Automation — (map)

            The automation properties of the numeric question.

            • PropertyValue — (map)

              The property value of the automation.

              • Label — required — (String)

                The property label of the automation.

                Possible values include:
                • "OVERALL_CUSTOMER_SENTIMENT_SCORE"
                • "OVERALL_AGENT_SENTIMENT_SCORE"
                • "NON_TALK_TIME"
                • "NON_TALK_TIME_PERCENTAGE"
                • "NUMBER_OF_INTERRUPTIONS"
                • "CONTACT_DURATION"
                • "AGENT_INTERACTION_DURATION"
                • "CUSTOMER_HOLD_TIME"
        • SingleSelect — (map)

          The properties of the numeric question.

          • Options — required — (Array<map>)

            The answer options of the single select question.

            • RefId — required — (String)

              The identifier of the answer option. An identifier must be unique within the question.

            • Text — required — (String)

              The title of the answer option.

            • Score — (Integer)

              The score assigned to the answer option.

            • AutomaticFail — (Boolean)

              The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

          • DisplayAs — (String)

            The display mode of the single select question.

            Possible values include:
            • "DROPDOWN"
            • "RADIO"
          • Automation — (map)

            The display mode of the single select question.

            • Options — required — (Array<map>)

              The automation options of the single select question.

              • RuleCategory — (map)

                The automation option based on a rule category for the single select question.

                • Category — required — (String)

                  The category name, as defined in Rules.

                • Condition — required — (String)

                  The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

                  Possible values include:
                  • "PRESENT"
                  • "NOT_PRESENT"
                • OptionRefId — required — (String)

                  The identifier of the answer option.

            • DefaultOptionRefId — (String)

              The identifier of the default answer option, when none of the automation options match the criteria.

      • Weight — (Float)

        The scoring weight of the section.

  • ScoringStrategy — (map)

    A scoring strategy of the evaluation form.

    • Mode — required — (String)

      The scoring mode of the evaluation form.

      Possible values include:
      • "QUESTION_ONLY"
      • "SECTION_ONLY"
    • Status — required — (String)

      The scoring status of the evaluation form.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EvaluationFormId — (String)

      The unique identifier for the evaluation form.

    • EvaluationFormArn — (String)

      The Amazon Resource Name (ARN) for the evaluation form resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Config: [ /* required */
    {
      Day: SUNDAY | MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY, /* required */
      EndTime: { /* required */
        Hours: 'NUMBER_VALUE', /* required */
        Minutes: 'NUMBER_VALUE' /* required */
      },
      StartTime: { /* required */
        Hours: 'NUMBER_VALUE', /* required */
        Minutes: 'NUMBER_VALUE' /* required */
      }
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  TimeZone: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createHoursOfOperation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name — (String)

    The name of the hours of operation.

  • Description — (String)

    The description of the hours of operation.

  • TimeZone — (String)

    The time zone of the hours of operation.

  • Config — (Array<map>)

    Configuration information for the hours of operation: day, start time, and end time.

    • Day — required — (String)

      The day that the hours of operation applies to.

      Possible values include:
      • "SUNDAY"
      • "MONDAY"
      • "TUESDAY"
      • "WEDNESDAY"
      • "THURSDAY"
      • "FRIDAY"
      • "SATURDAY"
    • StartTime — required — (map)

      The start time that your contact center opens.

      • Hours — required — (Integer)

        The hours.

      • Minutes — required — (Integer)

        The minutes.

    • EndTime — required — (map)

      The end time that your contact center closes.

      • Hours — required — (Integer)

        The hours.

      • Minutes — required — (Integer)

        The minutes.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HoursOfOperationId — (String)

      The identifier for the hours of operation.

    • HoursOfOperationArn — (String)

      The Amazon Resource Name (ARN) for the hours of operation.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IdentityManagementType: SAML | CONNECT_MANAGED | EXISTING_DIRECTORY, /* required */
  InboundCallsEnabled: true || false, /* required */
  OutboundCallsEnabled: true || false, /* required */
  ClientToken: 'STRING_VALUE',
  DirectoryId: 'STRING_VALUE',
  InstanceAlias: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    The idempotency token.

  • IdentityManagementType — (String)

    The type of identity management for your Amazon Connect users.

    Possible values include:
    • "SAML"
    • "CONNECT_MANAGED"
    • "EXISTING_DIRECTORY"
  • InstanceAlias — (String)

    The name for your instance.

  • DirectoryId — (String)

    The identifier for the directory.

  • InboundCallsEnabled — (Boolean)

    Your contact center handles incoming contacts.

  • OutboundCallsEnabled — (Boolean)

    Your contact center allows outbound calls.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Id — (String)

      The identifier for the instance.

    • Arn — (String)

      The Amazon Resource Name (ARN) of the instance.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  IntegrationArn: 'STRING_VALUE', /* required */
  IntegrationType: EVENT | VOICE_ID | PINPOINT_APP | WISDOM_ASSISTANT | WISDOM_KNOWLEDGE_BASE | WISDOM_QUICK_RESPONSES | CASES_DOMAIN | APPLICATION | FILE_SCANNER, /* required */
  SourceApplicationName: 'STRING_VALUE',
  SourceApplicationUrl: 'STRING_VALUE',
  SourceType: SALESFORCE | ZENDESK | CASES,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createIntegrationAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • IntegrationType — (String)

    The type of information to be ingested.

    Possible values include:
    • "EVENT"
    • "VOICE_ID"
    • "PINPOINT_APP"
    • "WISDOM_ASSISTANT"
    • "WISDOM_KNOWLEDGE_BASE"
    • "WISDOM_QUICK_RESPONSES"
    • "CASES_DOMAIN"
    • "APPLICATION"
    • "FILE_SCANNER"
  • IntegrationArn — (String)

    The Amazon Resource Name (ARN) of the integration.

    Note: When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
  • SourceApplicationUrl — (String)

    The URL for the external application. This field is only required for the EVENT integration type.

  • SourceApplicationName — (String)

    The name of the external application. This field is only required for the EVENT integration type.

  • SourceType — (String)

    The type of the data source. This field is only required for the EVENT integration type.

    Possible values include:
    • "SALESFORCE"
    • "ZENDESK"
    • "CASES"
  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • IntegrationAssociationId — (String)

      The identifier for the integration association.

    • IntegrationAssociationArn — (String)

      The Amazon Resource Name (ARN) for the association.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ParticipantDetails: { /* required */
    DisplayName: 'STRING_VALUE',
    ParticipantRole: AGENT | CUSTOMER | SYSTEM | CUSTOM_BOT | SUPERVISOR
  },
  ClientToken: 'STRING_VALUE'
};
connect.createParticipant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactId — (String)

    The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    If a token is not provided, the SDK will use a version 4 UUID.
  • ParticipantDetails — (map)

    Information identifying the participant.

    The only Valid value for ParticipantRole is CUSTOM_BOT.

    DisplayName is Required.

    • ParticipantRole — (String)

      The role of the participant being added.

      Possible values include:
      • "AGENT"
      • "CUSTOMER"
      • "SYSTEM"
      • "CUSTOM_BOT"
      • "SUPERVISOR"
    • DisplayName — (String)

      The display name of the participant.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ParticipantCredentials — (map)

      The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

      • ParticipantToken — (String)

        The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

      • Expiry — (String)

        The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

    • ParticipantId — (String)

      The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InitialContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  RehydrationType: ENTIRE_PAST_SESSION | FROM_SEGMENT, /* required */
  SourceContactId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connect.createPersistentContactAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • InitialContactId — (String)

    This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.

  • RehydrationType — (String)

    The contactId chosen for rehydration depends on the type chosen.

    • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

    • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

    The actual contactId used for rehydration is provided in the response of this API.

    To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

    • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

      • Configuration

        • SourceContactId = "C2"

        • RehydrationType = "FROM_SEGMENT"

      • Expected behavior

        • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

    • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

      • Configuration

        • SourceContactId = "C1"

        • RehydrationType = "ENTIRE_PAST_SESSION"

      • Expected behavior

        • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

    Possible values include:
    • "ENTIRE_PAST_SESSION"
    • "FROM_SEGMENT"
  • SourceContactId — (String)

    The contactId from which a persistent chat session must be started.

  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ContinuedFromContactId — (String)

      The contactId from which a persistent chat session is started. This field is populated only for persistent chat.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Values: { /* required */
    StringList: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
connect.createPredefinedAttribute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name — (String)

    The name of the predefined attribute.

  • Values — (map)

    The values of the predefined attribute.

    • StringList — (Array<String>)

      Predefined attribute values of type string list.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  S3Uri: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createPrompt(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name — (String)

    The name of the prompt.

  • Description — (String)

    The description of the prompt.

  • S3Uri — (String)

    The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PromptARN — (String)

      The Amazon Resource Name (ARN) of the prompt.

    • PromptId — (String)

      A unique identifier for the prompt.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HoursOfOperationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  MaxContacts: 'NUMBER_VALUE',
  OutboundCallerConfig: {
    OutboundCallerIdName: 'STRING_VALUE',
    OutboundCallerIdNumberId: 'STRING_VALUE',
    OutboundFlowId: 'STRING_VALUE'
  },
  QuickConnectIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name — (String)

    The name of the queue.

  • Description — (String)

    The description of the queue.

  • OutboundCallerConfig — (map)

    The outbound caller ID name, number, and outbound whisper flow.

    • OutboundCallerIdName — (String)

      The caller ID name.

    • OutboundCallerIdNumberId — (String)

      The caller ID number.

    • OutboundFlowId — (String)

      The outbound whisper flow to be used during an outbound call.

  • HoursOfOperationId — (String)

    The identifier for the hours of operation.

  • MaxContacts — (Integer)

    The maximum number of contacts that can be in the queue before it is considered full.

  • QuickConnectIds — (Array<String>)

    The quick connects available to agents who are working the queue.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QueueArn — (String)

      The Amazon Resource Name (ARN) of the queue.

    • QueueId — (String)

      The identifier for the queue.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  QuickConnectConfig: { /* required */
    QuickConnectType: USER | QUEUE | PHONE_NUMBER, /* required */
    PhoneConfig: {
      PhoneNumber: 'STRING_VALUE' /* required */
    },
    QueueConfig: {
      ContactFlowId: 'STRING_VALUE', /* required */
      QueueId: 'STRING_VALUE' /* required */
    },
    UserConfig: {
      ContactFlowId: 'STRING_VALUE', /* required */
      UserId: 'STRING_VALUE' /* required */
    }
  },
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createQuickConnect(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name — (String)

    A unique name of the quick connect.

  • Description — (String)

    The description of the quick connect.

  • QuickConnectConfig — (map)

    Configuration settings for the quick connect.

    • QuickConnectType — required — (String)

      The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

      Possible values include:
      • "USER"
      • "QUEUE"
      • "PHONE_NUMBER"
    • UserConfig — (map)

      The user configuration. This is required only if QuickConnectType is USER.

      • UserId — required — (String)

        The identifier of the user.

      • ContactFlowId — required — (String)

        The identifier of the flow.

    • QueueConfig — (map)

      The queue configuration. This is required only if QuickConnectType is QUEUE.

      • QueueId — required — (String)

        The identifier for the queue.

      • ContactFlowId — required — (String)

        The identifier of the flow.

    • PhoneConfig — (map)

      The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

      • PhoneNumber — required — (String)

        The phone number in E.164 format.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QuickConnectARN — (String)

      The Amazon Resource Name (ARN) for the quick connect.

    • QuickConnectId — (String)

      The identifier for the quick connect.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DefaultOutboundQueueId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  MediaConcurrencies: [ /* required */
    {
      Channel: VOICE | CHAT | TASK, /* required */
      Concurrency: 'NUMBER_VALUE', /* required */
      CrossChannelBehavior: {
        BehaviorType: ROUTE_CURRENT_CHANNEL_ONLY | ROUTE_ANY_CHANNEL /* required */
      }
    },
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  AgentAvailabilityTimer: TIME_SINCE_LAST_ACTIVITY | TIME_SINCE_LAST_INBOUND,
  QueueConfigs: [
    {
      Delay: 'NUMBER_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      QueueReference: { /* required */
        Channel: VOICE | CHAT | TASK, /* required */
        QueueId: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createRoutingProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceId — (String)

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name — (String)

    The name of the routing profile. Must not be more than 127 characters.

  • Description — (String)

    Description of the routing profile. Must not be more than 250 characters.

  • DefaultOutboundQueueId — (String)

    The default outbound queue for the routing profile.

  • QueueConfigs — (Array<map>)

    The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

    The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.

    • QueueReference — required — (map)

      Contains information about a queue resource.

      • QueueId — required — (String)

        The identifier for the queue.

      • Channel — required — (String)

        The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

        Possible values include:
        • "VOICE"
        • "CHAT"
        • "TASK"
    • Priority — required — (Integer)

      The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

    • Delay — required — (Integer)

      The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

  • MediaConcurrencies — (Array<map>)

    The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.

    • Channel — required — (String)

      The channels that agents can handle in the Contact Control Panel (CCP).

      Possible values include:
      • "VOICE"
      • "CHAT"
      • "TASK"
    • Concurrency — required — (Integer)

      The number of contacts an agent can have on a channel simultaneously.

      Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

      Valid Range for CHAT: Minimum value of 1. Maximum value of 10.

      Valid Range for TASK: Minimum value of 1. Maximum value of 10.

    • CrossChannelBehavior — (map)

      Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.

      • BehaviorType — required — (String)

        Specifies the other channels that can be routed to an agent handling their current channel.

        Possible values include:
        • "ROUTE_CURRENT_CHANNEL_ONLY"
        • "ROUTE_ANY_CHANNEL"
  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }.

  • AgentAvailabilityTimer — (String)

    Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.

    Possible values include:
    • "TIME_SINCE_LAST_ACTIVITY"
    • "TIME_SINCE_LAST_INBOUND"