Class: AWS.Connect

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, /* 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"
  • 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 = {
  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, /* 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.

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

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 = {
  PhoneNumber: 'STRING_VALUE', /* required */
  TargetArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  PhoneNumberDescription: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
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 numbers are claimed to.

  • 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 = {
  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',
  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 content of the flow.

  • 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 content of the flow module.

  • 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'
};
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.

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 | CASES_DOMAIN, /* required */
  SourceApplicationName: 'STRING_VALUE',
  SourceApplicationUrl: 'STRING_VALUE',
  SourceType: SALESFORCE | ZENDESK,
  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"
    • "CASES_DOMAIN"
  • 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"
  • 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
  },
  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"
    • 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 = {
  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.

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

    The 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 console, 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"

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:

    • RoutingProfileArn — (String)

      The Amazon Resource Name (ARN) of the routing profile.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

Returns:

• (AWS.Request) —

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

var params = {
  Actions: [ /* required */
    {
      ActionType: CREATE_TASK | ASSIGN_CONTACT_CATEGORY | GENERATE_EVENTBRIDGE_EVENT | SEND_NOTIFICATION, /* required */
      AssignContactCategoryAction: {
      },
      EventBridgeAction: {
        Name: 'STRING_VALUE' /* required */
      },
      SendNotificationAction: {
        Content: 'STRING_VALUE', /* required */
        ContentType: PLAIN_TEXT, /* required */
        DeliveryMethod: EMAIL, /* required */
        Recipient: { /* required */
          UserIds: [
            'STRING_VALUE',
            /* more items */
          ],
          UserTags: {
            '<String>': 'STRING_VALUE',
            /* '<String>': ... */
          }
        },
        Subject: 'STRING_VALUE'
      },
      TaskAction: {
        ContactFlowId: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        Description: 'STRING_VALUE',
        References: {
          '<ReferenceKey>': {
            Type: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL, /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* '<ReferenceKey>': ... */
        }
      }
    },
    /* more items */
  ],
  Function: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  PublishStatus: DRAFT | PUBLISHED, /* required */
  TriggerEventSource: { /* required */
    EventSourceName: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate, /* required */
    IntegrationAssociationId: 'STRING_VALUE'
  },
  ClientToken: 'STRING_VALUE'
};
connect.createRule(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 for the rule.

  • TriggerEventSource — (map)

    The event source to trigger the rule.

    • EventSourceName — required — (String)

      The name of the event source.

      Possible values include:
      • "OnPostCallAnalysisAvailable"
      • "OnRealTimeCallAnalysisAvailable"
      • "OnPostChatAnalysisAvailable"
      • "OnZendeskTicketCreate"
      • "OnZendeskTicketStatusUpdate"
      • "OnSalesforceCaseCreate"
      • "OnContactEvaluationSubmit"
      • "OnMetricDataUpdate"
    • IntegrationAssociationId — (String)

      The identifier for the integration association.

  • Function — (String)

    The conditions of the rule.

  • Actions — (Array<map>)

    A list of actions to be run when the rule is triggered.

    • ActionType — required — (String)

      The type of action that creates a rule.

      Possible values include:
      • "CREATE_TASK"
      • "ASSIGN_CONTACT_CATEGORY"
      • "GENERATE_EVENTBRIDGE_EVENT"
      • "SEND_NOTIFICATION"
    • TaskAction — (map)

      Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

      • Name — required — (String)

        The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

      • Description — (String)

        The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

      • ContactFlowId — required — (String)

        The identifier of the flow.

      • References — (map<map>)

        Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)

        • Value — required — (String)

          A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

        • Type — required — (String)

          The type of the reference. DATE must be of type Epoch timestamp.

          Possible values include:
          • "URL"
          • "ATTACHMENT"
          • "NUMBER"
          • "STRING"
          • "DATE"
          • "EMAIL"
    • EventBridgeAction — (map)

      Information about the EventBridge action.

      • Name — required — (String)

        The name.

    • AssignContactCategoryAction — (map)

      Information about the contact category action.

    • SendNotificationAction — (map)

      Information about the send notification action.

      • DeliveryMethod — required — (String)

        Notification delivery method.

        Possible values include:
        • "EMAIL"
      • Subject — (String)

        The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

      • Content — required — (String)

        Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

      • ContentType — required — (String)

        Content type format.

        Possible values include:
        • "PLAIN_TEXT"
      • Recipient — required — (map)

        Notification recipient.

        • UserTags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }. Amazon Connect users with the specified tags will be notified.

        • UserIds — (Array<String>)

          A list of user IDs.

  • PublishStatus — (String)

    The publish status of the rule.

    Possible values include:
    • "DRAFT"
    • "PUBLISHED"
  • 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:

    • RuleArn — (String)

      The Amazon Resource Name (ARN) of the rule.

    • RuleId — (String)

      A unique identifier for the rule.

Returns:

• (AWS.Request) —

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

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SecurityProfileName: 'STRING_VALUE', /* required */
  AllowedAccessControlTags: {
    '<SecurityProfilePolicyKey>': 'STRING_VALUE',
    /* '<SecurityProfilePolicyKey>': ... */
  },
  Description: 'STRING_VALUE',
  Permissions: [
    'STRING_VALUE',
    /* more items */
  ],
  TagRestrictedResources: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createSecurityProfile(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: {}) —
  • SecurityProfileName — (String)

    The name of the security profile.

  • Description — (String)

    The description of the security profile.

  • Permissions — (Array<String>)

    Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.

  • InstanceId — (String)

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

  • Tags — (map<String>)

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

  • AllowedAccessControlTags — (map<String>)

    The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

  • TagRestrictedResources — (Array<String>)

    The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile

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:

    • SecurityProfileId — (String)

      The identifier for the security profle.

    • SecurityProfileArn — (String)

      The Amazon Resource Name (ARN) for the security profile.

Returns:

• (AWS.Request) —

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

var params = {
  Fields: [ /* required */
    {
      Id: { /* required */
        Name: 'STRING_VALUE'
      },
      Description: 'STRING_VALUE',
      SingleSelectOptions: [
        'STRING_VALUE',
        /* more items */
      ],
      Type: NAME | DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Constraints: {
    InvisibleFields: [
      {
        Id: {
          Name: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    ReadOnlyFields: [
      {
        Id: {
          Name: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    RequiredFields: [
      {
        Id: {
          Name: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  ContactFlowId: 'STRING_VALUE',
  Defaults: {
    DefaultFieldValues: [
      {
        DefaultValue: 'STRING_VALUE',
        Id: {
          Name: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  Description: 'STRING_VALUE',
  Status: ACTIVE | INACTIVE
};
connect.createTaskTemplate(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 task template.

  • Description — (String)

    The description of the task template.

  • ContactFlowId — (String)

    The identifier of the flow that runs by default when a task is created by referencing this template.

  • Constraints — (map)

    Constraints that are applicable to the fields listed.

    • RequiredFields — (Array<map>)

      Lists the fields that are required to be filled by agents.

      • Id — (map)

        The unique identifier for the field.

        • Name — (String)

          The name of the task template field.

    • ReadOnlyFields — (Array<map>)

      Lists the fields that are read-only to agents, and cannot be edited.

      • Id — (map)

        Identifier of the read-only field.

        • Name — (String)

          The name of the task template field.

    • InvisibleFields — (Array<map>)

      Lists the fields that are invisible to agents.

      • Id — (map)

        Identifier of the invisible field.

        • Name — (String)

          The name of the task template field.

  • Defaults — (map)

    The default values for fields when a task is created by referencing this template.

    • DefaultFieldValues — (Array<map>)

      Default value for the field.

      • Id — (map)

        Identifier of a field.

        • Name — (String)

          The name of the task template field.

      • DefaultValue — (String)

        Default value for the field.

  • Status — (String)

    Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

    Possible values include:
    • "ACTIVE"
    • "INACTIVE"
  • Fields — (Array<map>)

    Fields that are part of the template.

    • Id — required — (map)

      The unique identifier for the field.

      • Name — (String)

        The name of the task template field.

    • Description — (String)

      The description of the field.

    • Type — (String)

      Indicates the type of field.

      Possible values include:
      • "NAME"
      • "DESCRIPTION"
      • "SCHEDULED_TIME"
      • "QUICK_CONNECT"
      • "URL"
      • "NUMBER"
      • "TEXT"
      • "TEXT_AREA"
      • "DATE_TIME"
      • "BOOLEAN"
      • "SINGLE_SELECT"
      • "EMAIL"
    • SingleSelectOptions — (Array<String>)

      A list of options for a single select field.

  • 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 task template resource.

    • Arn — (String)

      The Amazon Resource Name (ARN) for the task template resource.

Returns:

• (AWS.Request) —

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

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createTrafficDistributionGroup(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: {}) —
  • Name — (String)

    The name for the traffic distribution group.

  • Description — (String)

    A description for the traffic distribution group.

  • InstanceId — (String)

    The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.

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

    • Id — (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.

    • Arn — (String)

      The Amazon Resource Name (ARN) of the traffic distribution group.

Returns:

• (AWS.Request) —

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

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  IntegrationAssociationId: 'STRING_VALUE', /* required */
  UseCaseType: RULES_EVALUATION | CONNECT_CAMPAIGNS, /* required */
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createUseCase(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.

  • IntegrationAssociationId — (String)

    The identifier for the integration association.

  • UseCaseType — (String)

    The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

    Possible values include:
    • "RULES_EVALUATION"
    • "CONNECT_CAMPAIGNS"
  • 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:

    • UseCaseId — (String)

      The identifier of the use case.

    • UseCaseArn — (String)

      The Amazon Resource Name (ARN) for the use case.

Returns:

• (AWS.Request) —

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

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  PhoneConfig: { /* required */
    PhoneType: SOFT_PHONE | DESK_PHONE, /* required */
    AfterContactWorkTimeLimit: 'NUMBER_VALUE',
    AutoAccept: true || false,
    DeskPhoneNumber: 'STRING_VALUE'
  },
  RoutingProfileId: 'STRING_VALUE', /* required */
  SecurityProfileIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Username: 'STRING_VALUE', /* required */
  DirectoryUserId: 'STRING_VALUE',
  HierarchyGroupId: 'STRING_VALUE',
  IdentityInfo: {
    Email: 'STRING_VALUE',
    FirstName: 'STRING_VALUE',
    LastName: 'STRING_VALUE',
    Mobile: 'STRING_VALUE',
    SecondaryEmail: 'STRING_VALUE'
  },
  Password: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createUser(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: {}) —
  • Username — (String)

    The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

  • Password — (String)

    The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

  • IdentityInfo — (map)

    The information about the identity of the user.

    • FirstName — (String)

      The first name. This is required if you are using Amazon Connect or SAML for identity management.

    • LastName — (String)

      The last name. This is required if you are using Amazon Connect or SAML for identity management.

    • Email — (String)

      The email address. If you are using SAML for identity management and include this parameter, an error is returned.

    • SecondaryEmail — (String)

      The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

      Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,63}

    • Mobile — (String)

      The user's mobile number.

  • PhoneConfig — (map)

    The phone settings for the user.

    • PhoneType — required — (String)

      The phone type.

      Possible values include:
      • "SOFT_PHONE"
      • "DESK_PHONE"
    • AutoAccept — (Boolean)

      The Auto accept setting.

    • AfterContactWorkTimeLimit — (Integer)

      The After Call Work (ACW) timeout setting, in seconds.

      Note: When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
    • DeskPhoneNumber — (String)

      The phone number for the user's desk phone.

  • DirectoryUserId — (String)

    The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

    This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

  • SecurityProfileIds — (Array<String>)

    The identifier of the security profile for the user.

  • RoutingProfileId — (String)

    The identifier of the routing profile for the user.

  • HierarchyGroupId — (String)

    The identifier of the hierarchy group for 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.

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

    • UserId — (String)

      The identifier of the user account.

    • UserArn — (String)

      The Amazon Resource Name (ARN) of the user account.

Returns:

• (AWS.Request) —

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

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ParentGroupId: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createUserHierarchyGroup(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: {}) —
  • Name — (String)

    The name of the user hierarchy group. Must not be more than 100 characters.

  • ParentGroupId — (String)

    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

  • InstanceId — (String)

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

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

    • HierarchyGroupId — (String)

      The identifier of the hierarchy group.

    • HierarchyGroupArn — (String)

      The Amazon Resource Name (ARN) of the hierarchy group.

Returns:

• (AWS.Request) —

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

var params = {
  Content: { /* required */
    Actions: [
      'STRING_VALUE',
      /* more items */
    ],
    Template: 'STRING_VALUE'
  },
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Status: PUBLISHED | SAVED, /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createView(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 instanceId in the ARN of the instance.

  • ClientToken — (String)

    A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.

  • Status — (String)

    Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

    Possible values include:
    • "PUBLISHED"
    • "SAVED"
  • Content — (map)

    View content containing all content necessary to render a view except for runtime input data.

    The total uncompressed content has a maximum file size of 400kB.

    • Template — (String)

      The view template representing the structure of the view.

    • Actions — (Array<String>)

      A list of possible actions from the view.

  • Description — (String)

    The description of the view.

  • Name — (String)

    The name of the view.

  • Tags — (map<String>)

    The tags associated with the view resource (not specific to view version).These tags can be 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:

    • View — (map)

      A view resource object. Contains metadata and content necessary to render the view.

      • Id — (String)

        The identifier of the view.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the view.

      • Name — (String)

        The name of the view.

      • Status — (String)

        Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

        Possible values include:
        • "PUBLISHED"
        • "SAVED"
      • Type — (String)

        The type of the view - CUSTOMER_MANAGED.

        Possible values include:
        • "CUSTOMER_MANAGED"
        • "AWS_MANAGED"
      • Description — (String)

        The description of the view.

      • Version — (Integer)

        Current version of the view.

      • VersionDescription — (String)

        The description of the version.

      • Content — (map)

        View content containing all content necessary to render a view except for runtime input data.

        • InputSchema — (String)

          The data schema matching data that the view template must be provided to render.

        • Template — (String)

          The view template representing the structure of the view.

        • Actions — (Array<String>)

          A list of possible actions from the view.

      • Tags — (map<String>)

        The tags associated with the view resource (not specific to view version).

      • CreatedTime — (Date)

        The timestamp of when the view was created.

      • LastModifiedTime — (Date)

        Latest timestamp of the UpdateViewContent or CreateViewVersion operations.

      • ViewContentSha256 — (String)

        Indicates the checksum value of the latest published view content.

Returns:

• (AWS.Request) —

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

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ViewId: 'STRING_VALUE', /* required */
  VersionDescription: 'STRING_VALUE',
  ViewContentSha256: 'STRING_VALUE'
};
connect.createViewVersion(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 instanceId in the ARN of the instance.

  • ViewId — (String)

    The identifier of the view. Both ViewArn and ViewId can be used.

  • VersionDescription — (String)

    The description for the version being published.

  • ViewContentSha256 — (String)

    Indicates the checksum value of the latest published view content.

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:

    • View — (map)

      All view data is contained within the View object.

      • Id — (String)

        The identifier of the view.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the view.

      • Name — (String)

        The name of the view.

      • Status — (String)

        Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

        Possible values include:
        • "PUBLISHED"
        • "SAVED"
      • Type — (String)

        The type of the view - CUSTOMER_MANAGED.

        Possible values include:
        • "CUSTOMER_MANAGED"
        • "AWS_MANAGED"
      • Description — (String)

        The description of the view.

      • Version — (Integer)

        Current version of the view.

      • VersionDescription — (String)

        The description of the version.

      • Content — (map)

        View content containing all content necessary to render a view except for runtime input data.

        • InputSchema — (String)

          The data schema matching data that the view template must be provided to render.

        • Template — (String)

          The view template representing the structure of the view.

        • Actions — (Array<String>)

          A list of possible actions from the view.

      • Tags — (map<String>)

        The tags associated with the view resource (not specific to view version).

      • CreatedTime — (Date)

        The timestamp of when the view was created.

      • LastModifiedTime — (Date)

        Latest timestamp of the UpdateViewContent or CreateViewVersion operations.

      • ViewContentSha256 — (String)

        Indicates the checksum value of the latest published view content.

Returns:

• (AWS.Request) —

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

var params = {
  Content: 'STRING_VALUE', /* required */
  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, /* required */
  VocabularyName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createVocabulary(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 create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

    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.

  • VocabularyName — (String)

    A unique name of the custom vocabulary.

  • 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"
  • Content — (String)

    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

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

    • VocabularyArn — (String)

      The Amazon Resource Name (ARN) of the custom vocabulary.

    • VocabularyId — (String)

      The identifier of the custom vocabulary.

    • State — (String)

      The current state of the custom vocabulary.

      Possible values include:
      • "CREATION_IN_PROGRESS"
      • "ACTIVE"
      • "CREATION_FAILED"
      • "DELETE_IN_PROGRESS"

Returns:

• (AWS.Request) —

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

var params = {
  EvaluationFormId: 'STRING_VALUE', /* required */
  EvaluationFormVersion: 'NUMBER_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deactivateEvaluationForm(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.

  • EvaluationFormId — (String)

    The unique identifier for the evaluation form.

  • EvaluationFormVersion — (Integer)

    A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.

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.

    • EvaluationFormVersion — (Integer)

      The version of the deactivated evaluation form resource.