Class: AWS.Connect

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LexBot: {
    LexRegion: 'STRING_VALUE',
    Name: 'STRING_VALUE'
  },
  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 instanceId in the ARN of the instance.

  • LexBot — (map)

    Configuration information of an Amazon Lex bot.

    • Name — (String)

      The name of the Amazon Lex bot.

    • LexRegion — (String)

      The Region that the Amazon Lex bot was created in.

  • 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, /* 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 instanceId in the 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"
  • 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, /* 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 instanceId in the 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"
  • 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.
    • 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.
    • 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 instanceId in the 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',
    Name: 'STRING_VALUE'
  }
};
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 instanceId in the ARN of the instance.

  • LexBot — (map)

    The Amazon Lex bot to associate with the instance.

    • Name — (String)

      The name of the Amazon Lex bot.

    • LexRegion — (String)

      The Region that the Amazon Lex bot was created in.

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 instanceId in the ARN of the instance.

  • ContactFlowId — (String)

    The identifier of the contact 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 instanceId in the 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 instanceId in the 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 instanceId in the 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 = {
  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 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.

  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    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 instanceId in the 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.

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

  • Type — (String)

    The type of the contact flow. For descriptions of the available types, see Choose a Contact 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 contact flow.

  • Content — (String)

    The content of the contact flow.

  • Tags — (map<String>)

    One or more tags.

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

    • ContactFlowArn — (String)

      The Amazon Resource Name (ARN) of the contact 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 instanceId in the ARN of the instance.

  • Name — (String)

    The name of the contact flow module.

  • Description — (String)

    The description of the contact flow module.

  • Content — (String)

    The content of the contact flow module.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource.

  • ClientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    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 contact flow module.

    • Arn — (String)

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

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 instanceId in the 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.

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, /* 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 instanceId in the 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"
  • IntegrationArn — (String)

    The Amazon Resource Name (ARN) of the integration.

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

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 = {
  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 instanceId in the 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.

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 instanceId in the 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 contact 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 contact 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.

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 */
    },
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  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 instanceId in the 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.

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

  • Tags — (map<String>)

    One or more tags.

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 = {
  InstanceId: 'STRING_VALUE', /* required */
  SecurityProfileName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Permissions: [
    '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.

  • InstanceId — (String)

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

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource.

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 = {
  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 instanceId in the 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.

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'
  },
  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.

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

    • 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 instanceId in the ARN of the instance.

  • Tags — (map<String>)

    One or more tags.

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 instanceId in the ARN of the instance.

  • Tags — (map<String>)

    The tags used to organize, track, or control access for this resource.

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: '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, /* 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 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 instanceId in the 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"
  • 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.

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 = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteContactFlow(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.

  • ContactFlowId — (String)

    The identifier of the contact 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 = {
  ContactFlowModuleId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteContactFlowModule(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.

  • ContactFlowModuleId — (String)

    The identifier of the contact flow module.

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 = {
  HoursOfOperationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteHoursOfOperation(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.

  • HoursOfOperationId — (String)

    The identifier for the hours of operation.

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 */
};
connect.deleteInstance(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.

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 */
  IntegrationAssociationId: 'STRING_VALUE' /* required */
};
connect.deleteIntegrationAssociation(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.

  • IntegrationAssociationId — (String)

    The identifier for the integration association.

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 */
  QuickConnectId: 'STRING_VALUE' /* required */
};
connect.deleteQuickConnect(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.

  • QuickConnectId — (String)

    The identifier for the quick connect.

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 */
  SecurityProfileId: 'STRING_VALUE' /* required */
};
connect.deleteSecurityProfile(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.

  • SecurityProfileId — (String)

    The identifier for the security profle.

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 */
  IntegrationAssociationId: 'STRING_VALUE', /* required */
  UseCaseId: 'STRING_VALUE' /* required */
};
connect.deleteUseCase(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.

  • IntegrationAssociationId — (String)

    The identifier for the integration association.

  • UseCaseId — (String)

    The identifier for the use case.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

  • UserId — (String)

    The identifier of the user.

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 = {
  HierarchyGroupId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteUserHierarchyGroup(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: {}) —
  • HierarchyGroupId — (String)

    The identifier of the hierarchy group.

  • InstanceId — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

  • VocabularyId — (String)

    The identifier of the custom vocabulary.

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 = {
  AgentStatusId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeAgentStatus(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.

  • AgentStatusId — (String)

    The identifier for the agent status.

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:

    • AgentStatus — (map)

      The agent status.

      • AgentStatusARN — (String)

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

      • AgentStatusId — (String)

        The identifier of the agent status.

      • Name — (String)

        The name of the agent status.

      • Description — (String)

        The description of the agent status.

      • Type — (String)

        The type of agent status.

        Possible values include:
        • "ROUTABLE"
        • "CUSTOM"
        • "OFFLINE"
      • DisplayOrder — (Integer)

        The display order of the agent status.

      • State — (String)

        The state of the agent status.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

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

  • ContactId — (String)

    The identifier of the contact.

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:

    • Contact — (map)

      Information about the contact.

      • Arn — (String)

        The Amazon Resource Name (ARN) for the contact.

      • Id — (String)

        The identifier for the contact.

      • InitialContactId — (String)

        If this contact is related to other contacts, this is the ID of the initial contact.

      • PreviousContactId — (String)

        If this contact is not the first contact, this is the ID of the previous contact.

      • InitiationMethod — (String)

        Indicates how the contact was initiated.

        Possible values include:
        • "INBOUND"
        • "OUTBOUND"
        • "TRANSFER"
        • "QUEUE_TRANSFER"
        • "CALLBACK"
        • "API"
      • Name — (String)

        The name of the contact.

      • Description — (String)

        The description of the contact.

      • Channel — (String)

        How the contact reached your contact center.

        Possible values include:
        • "VOICE"
        • "CHAT"
        • "TASK"
      • QueueInfo — (map)

        If this contact was queued, this contains information about the queue.

        • Id — (String)

          The identifier of the agent who accepted the contact.

        • EnqueueTimestamp — (Date)

          The timestamp when the contact was added to the queue.

      • AgentInfo — (map)

        Information about the agent who accepted the contact.

        • Id — (String)

          The identifier of the agent who accepted the contact.

        • ConnectedToAgentTimestamp — (Date)

          The timestamp when the contact was connected to the agent.

      • InitiationTimestamp — (Date)

        The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived.

      • DisconnectTimestamp — (Date)

        The timestamp when the customer endpoint disconnected from Amazon Connect.

      • LastUpdateTimestamp — (Date)

        The timestamp when contact was last updated.

      • ScheduledTimestamp — (Date)

        The timestamp, in Unix epoch time format, at which to start running the inbound flow.

Returns:

• (AWS.Request) —

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

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

  • ContactFlowId — (String)

    The identifier of the contact 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. The data object has the following properties:

    • ContactFlow — (map)

      Information about the contact flow.

      • Arn — (String)

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

      • Id — (String)

        The identifier of the contact flow.

      • Name — (String)

        The name of the contact flow.

      • Type — (String)

        The type of the contact flow. For descriptions of the available types, see Choose a Contact 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"
      • State — (String)

        The type of contact flow.

        Possible values include:
        • "ACTIVE"
        • "ARCHIVED"
      • Description — (String)

        The description of the contact flow.

      • Content — (String)

        The content of the contact flow.

      • Tags — (map<String>)

        One or more tags.

Returns:

• (AWS.Request) —

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

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

  • ContactFlowModuleId — (String)

    The identifier of the contact flow module.

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:

    • ContactFlowModule — (map)

      Information about the contact flow module.

      • Arn — (String)

        The Amazon Resource Name (ARN).

      • Id — (String)

        The identifier of the contact flow module.

      • Name — (String)

        The name of the contact flow module.

      • Content — (String)

        The content of the contact flow module.

      • Description — (String)

        The description of the contact flow module.

      • State — (String)

        The type of contact flow module.

        Possible values include:
        • "ACTIVE"
        • "ARCHIVED"
      • Status — (String)

        The status of the contact flow module.

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

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

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

  • HoursOfOperationId — (String)

    The identifier for the hours of operation.

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:

    • HoursOfOperation — (map)

      The hours of operation.

      • HoursOfOperationId — (String)

        The identifier for the hours of operation.

      • HoursOfOperationArn — (String)

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

      • Name — (String)

        The name for the hours of operation.

      • Description — (String)

        The description for the hours of operation.

      • TimeZone — (String)

        The time zone for the hours of operation.

      • Config — (Array<map>)

        Configuration information for the hours of operation.

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

Returns:

• (AWS.Request) —

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

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

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:

    • Instance — (map)

      The name of the instance.

      • Id — (String)

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

      • Arn — (String)

        The Amazon Resource Name (ARN) of the instance.

      • IdentityManagementType — (String)

        The identity management type.

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

        The alias of instance.

      • CreatedTime — (Date)

        When the instance was created.

      • ServiceRole — (String)

        The service role of the instance.

      • InstanceStatus — (String)

        The state of the instance.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "ACTIVE"
        • "CREATION_FAILED"
      • StatusReason — (map)

        Relevant details why the instance was not successfully created.

        • Message — (String)

          The message.

      • InboundCallsEnabled — (Boolean)

        Whether inbound calls are enabled.

      • OutboundCallsEnabled — (Boolean)

        Whether outbound calls are enabled.

Returns:

• (AWS.Request) —

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

var params = {
  AttributeType: INBOUND_CALLS | OUTBOUND_CALLS | CONTACTFLOW_LOGS | CONTACT_LENS | AUTO_RESOLVE_BEST_VOICES | USE_CUSTOM_TTS_VOICES | EARLY_MEDIA | MULTI_PARTY_CONFERENCE, /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeInstanceAttribute(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.

  • AttributeType — (String)

    The type of attribute.

    Possible values include:
    • "INBOUND_CALLS"
    • "OUTBOUND_CALLS"
    • "CONTACTFLOW_LOGS"
    • "CONTACT_LENS"
    • "AUTO_RESOLVE_BEST_VOICES"
    • "USE_CUSTOM_TTS_VOICES"
    • "EARLY_MEDIA"
    • "MULTI_PARTY_CONFERENCE"

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:

    • Attribute — (map)

      The type of attribute.

      • AttributeType — (String)

        The type of attribute.

        Possible values include:
        • "INBOUND_CALLS"
        • "OUTBOUND_CALLS"
        • "CONTACTFLOW_LOGS"
        • "CONTACT_LENS"
        • "AUTO_RESOLVE_BEST_VOICES"
        • "USE_CUSTOM_TTS_VOICES"
        • "EARLY_MEDIA"
        • "MULTI_PARTY_CONFERENCE"
      • Value — (String)

        The value of the attribute.

Returns:

• (AWS.Request) —

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

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ResourceType: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS /* required */
};
connect.describeInstanceStorageConfig(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.

  • AssociationId — (String)

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

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

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:

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

Returns:

• (AWS.Request) —

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

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
connect.describePhoneNumber(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.

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:

    • ClaimedPhoneNumberSummary — (map)

      Information about a phone number that's been claimed to your Amazon Connect instance.

      • PhoneNumberId — (String)

        A unique identifier for the phone number.

      • PhoneNumberArn — (String)

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

      • PhoneNumber — (String)

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

      • PhoneNumberCountryCode — (String)

        The ISO country code.

        Possible values include:
        • "AF"
        • "AL"
        • "DZ"
        • "AS"
        • "AD"
        • "AO"
        • "AI"
        • "AQ"
        • "AG"
        • "AR"
        • "AM"
        • "AW"
        • "AU"
        • "AT"
        • "AZ"
        • "BS"
        • "BH"
        • "BD"
        • "BB"
        • "BY"
        • "BE"
        • "BZ"
        • "BJ"
        • "BM"
        • "BT"
        • "BO"
        • "BA"
        • "BW"
        • "BR"
        • "IO"
        • "VG"
        • "BN"
        • "BG"
        • "BF"
        • "BI"
        • "KH"
        • "CM"
        • "CA"
        • "CV"
        • "KY"
        • "CF"
        • "TD"
        • "CL"
        • "CN"
        • "CX"
        • "CC"
        • "CO"
        • "KM"
        • "CK"
        • "CR"
        • "HR"
        • "CU"
        • "CW"
        • "CY"
        • "CZ"
        • "CD"
        • "DK"
        • "DJ"
        • "DM"
        • "DO"
        • "TL"
        • "EC"
        • "EG"
        • "SV"
        • "GQ"
        • "ER"
        • "EE"
        • "ET"
        • "FK"
        • "FO"
        • "FJ"
        • "FI"
        • "FR"
        • "PF"
        • "GA"
        • "GM"
        • "GE"
        • "DE"
        • "GH"
        • "GI"
        • "GR"
        • "GL"
        • "GD"
        • "GU"
        • "GT"
        • "GG"
        • "GN"
        • "GW"
        • "GY"
        • "HT"
        • "HN"
        • "HK"
        • "HU"
        • "IS"
        • "IN"
        • "ID"
        • "IR"
        • "IQ"
        • "IE"
        • "IM"
        • "IL"
        • "IT"
        • "CI"
        • "JM"
        • "JP"
        • "JE"
        • "JO"
        • "KZ"
        • "KE"
        • "KI"
        • "KW"
        • "KG"
        • "LA"
        • "LV"
        • "LB"
        • "LS"
        • "LR"
        • "LY"
        • "LI"
        • "LT"
        • "LU"
        • "MO"
        • "MK"
        • "MG"
        • "MW"
        • "MY"
        • "MV"
        • "ML"
        • "MT"
        • "MH"
        • "MR"
        • "MU"
        • "YT"
        • "MX"
        • "FM"
        • "MD"
        • "MC"
        • "MN"
        • "ME"
        • "MS"
        • "MA"
        • "MZ"
        • "MM"
        • "NA"
        • "NR"
        • "NP"
        • "NL"
        • "AN"
        • "NC"
        • "NZ"
        • "NI"
        • "NE"
        • "NG"
        • "NU"
        • "KP"
        • "MP"
        • "NO"
        • "OM"
        • "PK"
        • "PW"
        • "PA"
        • "PG"
        • "PY"
        • "PE"
        • "PH"
        • "PN"
        • "PL"
        • "PT"
        • "PR"
        • "QA"
        • "CG"
        • "RE"
        • "RO"
        • "RU"
        • "RW"
        • "BL"
        • "SH"
        • "KN"
        • "LC"
        • "MF"
        • "PM"
        • "VC"
        • "WS"
        • "SM"
        • "ST"
        • "SA"
        • "SN"
        • "RS"
        • "SC"
        • "SL"
        • "SG"
        • "SX"
        • "SK"
        • "SI"
        • "SB"
        • "SO"
        • "ZA"
        • "KR"
        • "ES"
        • "LK"
        • "SD"
        • "SR"
        • "SJ"
        • "SZ"
        • "SE"
        • "CH"
        • "SY"
        • "TW"
        • "TJ"
        • "TZ"
        • "TH"
        • "TG"
        • "TK"
        • "TO"
        • "TT"
        • "TN"
        • "TR"
        • "TM"
        • "TC"
        • "TV"
        • "VI"
        • "UG"
        • "UA"
        • "AE"
        • "GB"
        • "US"
        • "UY"
        • "UZ"
        • "VU"
        • "VA"
        • "VE"
        • "VN"
        • "WF"
        • "EH"
        • "YE"
        • "ZM"
        • "ZW"
      • PhoneNumberType — (String)

        The type of phone number.

        Possible values include:
        • "TOLL_FREE"
        • "DID"
      • PhoneNumberDescription — (String)

        The description of the phone number.

      • TargetArn — (String)

        The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

      • PhoneNumberStatus — (map)

        The status of the phone number.

        • Status — (String)

          The status.

          Possible values include:
          • "CLAIMED"
          • "IN_PROGRESS"
          • "FAILED"
        • Message — (String)

          The status message.