Class: Aws::ConnectParticipant::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb

Overview

An API client for ConnectParticipant. To construct a client, you need to configure a :region and :credentials.

client = Aws::ConnectParticipant::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



348
349
350
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 348

def initialize(*args)
  super
end

Instance Method Details

#complete_attachment_upload(params = {}) ⇒ Struct

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Examples:

Request syntax with placeholder values


resp = client.complete_attachment_upload({
  attachment_ids: ["ArtifactId"], # required
  client_token: "NonEmptyClientToken", # required
  connection_token: "ParticipantToken", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attachment_ids (required, Array<String>) —

    A list of unique identifiers for the attachments.

  • :client_token (required, String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :connection_token (required, String) —

    The authentication token associated with the participant's connection.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



392
393
394
395
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 392

def complete_attachment_upload(params = {}, options = {})
  req = build_request(:complete_attachment_upload, params)
  req.send_request(options)
end

#create_participant_connection(params = {}) ⇒ Types::CreateParticipantConnectionResponse

Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

\{"topic":"aws/subscribe","content":\{"topics":["aws/chat"]\}\}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Examples:

Request syntax with placeholder values


resp = client.create_participant_connection({
  type: ["WEBSOCKET"], # required, accepts WEBSOCKET, CONNECTION_CREDENTIALS
  participant_token: "ParticipantToken", # required
  connect_participant: false,
})

Response structure


resp.websocket.url #=> String
resp.websocket.connection_expiry #=> String
resp.connection_credentials.connection_token #=> String
resp.connection_credentials.expiry #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :type (required, Array<String>) —

    Type of connection information required.

  • :participant_token (required, String) —

    This is a header parameter.

    The ParticipantToken as obtained from StartChatContact API response.

  • :connect_participant (Boolean) —

    Amazon Connect Participant is used to mark the participant as connected for message streaming.

Returns:

See Also:



480
481
482
483
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 480

def create_participant_connection(params = {}, options = {})
  req = build_request(:create_participant_connection, params)
  req.send_request(options)
end

#disconnect_participant(params = {}) ⇒ Struct

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Examples:

Request syntax with placeholder values


resp = client.disconnect_participant({
  client_token: "ClientToken",
  connection_token: "ParticipantToken", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :connection_token (required, String) —

    The authentication token associated with the participant's connection.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



519
520
521
522
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 519

def disconnect_participant(params = {}, options = {})
  req = build_request(:disconnect_participant, params)
  req.send_request(options)
end

#get_attachment(params = {}) ⇒ Types::GetAttachmentResponse

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Examples:

Request syntax with placeholder values


resp = client.get_attachment({
  attachment_id: "ArtifactId", # required
  connection_token: "ParticipantToken", # required
})

Response structure


resp.url #=> String
resp.url_expiry #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attachment_id (required, String) —

    A unique identifier for the attachment.

  • :connection_token (required, String) —

    The authentication token associated with the participant's connection.

Returns:

See Also:



562
563
564
565
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 562

def get_attachment(params = {}, options = {})
  req = build_request(:get_attachment, params)
  req.send_request(options)
end

#get_transcript(params = {}) ⇒ Types::GetTranscriptResponse

Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_transcript({
  contact_id: "ContactId",
  max_results: 1,
  next_token: "NextToken",
  scan_direction: "FORWARD", # accepts FORWARD, BACKWARD
  sort_order: "DESCENDING", # accepts DESCENDING, ASCENDING
  start_position: {
    id: "ChatItemId",
    absolute_time: "Instant",
    most_recent: 1,
  },
  connection_token: "ParticipantToken", # required
})

Response structure


resp.initial_contact_id #=> String
resp.transcript #=> Array
resp.transcript[0].absolute_time #=> String
resp.transcript[0].content #=> String
resp.transcript[0].content_type #=> String
resp.transcript[0].id #=> String
resp.transcript[0].type #=> String, one of "TYPING", "PARTICIPANT_JOINED", "PARTICIPANT_LEFT", "CHAT_ENDED", "TRANSFER_SUCCEEDED", "TRANSFER_FAILED", "MESSAGE", "EVENT", "ATTACHMENT", "CONNECTION_ACK"
resp.transcript[0].participant_id #=> String
resp.transcript[0].display_name #=> String
resp.transcript[0].participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM"
resp.transcript[0].attachments #=> Array
resp.transcript[0].attachments[0].content_type #=> String
resp.transcript[0].attachments[0].attachment_id #=> String
resp.transcript[0].attachments[0].attachment_name #=> String
resp.transcript[0].attachments[0].status #=> String, one of "APPROVED", "REJECTED", "IN_PROGRESS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_id (String) —

    The contactId from the current contact chain for which transcript is needed.

  • :max_results (Integer) —

    The maximum number of results to return in the page. Default: 10.

  • :next_token (String) —

    The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

  • :scan_direction (String) —

    The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

  • :sort_order (String) —

    The sort order for the records. Default: DESCENDING.

  • :start_position (Types::StartPosition) —

    A filtering option for where to start.

  • :connection_token (required, String) —

    The authentication token associated with the participant's connection.

Returns:

See Also:



651
652
653
654
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 651

def get_transcript(params = {}, options = {})
  req = build_request(:get_transcript, params)
  req.send_request(options)
end

#send_event(params = {}) ⇒ Types::SendEventResponse

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Examples:

Request syntax with placeholder values


resp = client.send_event({
  content_type: "ChatContentType", # required
  content: "ChatContent",
  client_token: "ClientToken",
  connection_token: "ParticipantToken", # required
})

Response structure


resp.id #=> String
resp.absolute_time #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_type (required, String) —

    The content type of the request. Supported types are:

    • application/vnd.amazonaws.connect.event.typing

    • application/vnd.amazonaws.connect.event.connection.acknowledged

  • :content (String) —

    The content of the event to be sent (for example, message text). This is not yet supported.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :connection_token (required, String) —

    The authentication token associated with the participant's connection.

Returns:

See Also:



711
712
713
714
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 711

def send_event(params = {}, options = {})
  req = build_request(:send_event, params)
  req.send_request(options)
end

#send_message(params = {}) ⇒ Types::SendMessageResponse

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Examples:

Request syntax with placeholder values


resp = client.send_message({
  content_type: "ChatContentType", # required
  content: "ChatContent", # required
  client_token: "ClientToken",
  connection_token: "ParticipantToken", # required
})

Response structure


resp.id #=> String
resp.absolute_time #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_type (required, String) —

    The type of the content. Supported types are text/plain.

  • :content (required, String) —

    The content of the message.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :connection_token (required, String) —

    The authentication token associated with the connection.

Returns:

See Also:



765
766
767
768
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 765

def send_message(params = {}, options = {})
  req = build_request(:send_message, params)
  req.send_request(options)
end

#start_attachment_upload(params = {}) ⇒ Types::StartAttachmentUploadResponse

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Examples:

Request syntax with placeholder values


resp = client.start_attachment_upload({
  content_type: "ContentType", # required
  attachment_size_in_bytes: 1, # required
  attachment_name: "AttachmentName", # required
  client_token: "NonEmptyClientToken", # required
  connection_token: "ParticipantToken", # required
})

Response structure


resp.attachment_id #=> String
resp.upload_metadata.url #=> String
resp.upload_metadata.url_expiry #=> String
resp.upload_metadata.headers_to_include #=> Hash
resp.upload_metadata.headers_to_include["UploadMetadataSignedHeadersKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_type (required, String) —

    Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

  • :attachment_size_in_bytes (required, Integer) —

    The size of the attachment in bytes.

  • :attachment_name (required, String) —

    A case-sensitive name of the attachment being uploaded.

  • :client_token (required, String) —

    A unique case sensitive identifier to support idempotency of request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :connection_token (required, String) —

    The authentication token associated with the participant's connection.

Returns:

See Also:



832
833
834
835
 
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 832

def start_attachment_upload(params = {}, options = {})
  req = build_request(:start_attachment_upload, params)
  req.send_request(options)
end