Class: Aws::ConnectParticipant::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.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::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV 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:

  • :access_key_id (String)
  • :account_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.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

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

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :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 ClientStubs#stub_responses. See ClientStubs for more information.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

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

  • :endpoint_provider (Aws::ConnectParticipant::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ConnectParticipant::EndpointParameters`.

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

  • :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_open_timeout (Float) — default: 15 —

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

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

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



467
468
469
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 467

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1287
1288
1289
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 1287

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1290
1291
1292
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 1290

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 1260

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::ConnectParticipant')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-connectparticipant'
  context[:gem_version] = '1.61.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_participant_authentication(params = {}) ⇒ Struct

Cancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken.

<note markdown=“1”> The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats.

</note>

Examples:

Request syntax with placeholder values


resp = client.cancel_participant_authentication({
  session_id: "SessionId", # required
  connection_token: "ParticipantToken", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :session_id (required, String) —

    The ‘sessionId` provided in the `authenticationInitiated` event.

  • :connection_token (required, String) —

    The authentication token associated with the participant’s connection.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



501
502
503
504
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 501

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

#complete_attachment_upload(params = {}) ⇒ Struct

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded.

For security recommendations, see [Amazon Connect Chat security best practices].

<note markdown=“1”> ‘ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

</note>

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

[1]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs].

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

    [1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

  • :connection_token (required, String) —

    The authentication token associated with the participant’s connection.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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.

For security recommendations, see [Amazon Connect Chat security best practices].

<note markdown=“1”> ‘ParticipantToken` is used for invoking this API instead of `ConnectionToken`.

</note>

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:

‘href=""aws/chat"">topics”:}`

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

<note markdown=“1”> The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication].

</note>

[1]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat [2]: docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html [3]: docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html [4]: docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits [5]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

Examples:

Request syntax with placeholder values


resp = client.create_participant_connection({
  type: ["WEBSOCKET"], # 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 (Array<String>) —

    Type of connection information required. If you need ‘CONNECTION_CREDENTIALS` along with marking participant as connected, pass `CONNECTION_CREDENTIALS` in `Type`.

  • :participant_token (required, String) —

    This is a header parameter.

    The ParticipantToken as obtained from [StartChatContact] API response.

    [1]: docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html

  • :connect_participant (Boolean) —

    Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.

Returns:

See Also:



660
661
662
663
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 660

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

#describe_view(params = {}) ⇒ Types::DescribeViewResponse

Retrieves the view for the specified view token.

For security recommendations, see [Amazon Connect Chat security best practices].

[1]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat

Examples:

Request syntax with placeholder values


resp = client.describe_view({
  view_token: "ViewToken", # required
  connection_token: "ParticipantToken", # required
})

Response structure


resp.view.id #=> String
resp.view.arn #=> String
resp.view.name #=> String
resp.view.version #=> Integer
resp.view.content.input_schema #=> String
resp.view.content.template #=> String
resp.view.content.actions #=> Array
resp.view.content.actions[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :view_token (required, String) —

    An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.

  • :connection_token (required, String) —

    The connection token.

Returns:

See Also:



707
708
709
710
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 707

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

#disconnect_participant(params = {}) ⇒ Struct

Disconnects a participant.

For security recommendations, see [Amazon Connect Chat security best practices].

<note markdown=“1”> ‘ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

</note>

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

[1]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs].

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

    [1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

  • :connection_token (required, String) —

    The authentication token associated with the participant’s connection.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



760
761
762
763
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 760

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.

For security recommendations, see [Amazon Connect Chat security best practices].

<note markdown=“1”> ‘ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

</note>

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

[1]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

Examples:

Request syntax with placeholder values


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

Response structure


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

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.

  • :url_expiry_in_seconds (Integer) —

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

Returns:

See Also:



820
821
822
823
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 820

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

#get_authentication_url(params = {}) ⇒ Types::GetAuthenticationUrlResponse

Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block.

For security recommendations, see [Amazon Connect Chat security best practices].

<note markdown=“1”> * This API can only be called within one minute of receiving the

authenticationInitiated event.

  • The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats.

</note>

[1]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat

Examples:

Request syntax with placeholder values


resp = client.get_authentication_url({
  session_id: "SessionId", # required
  redirect_uri: "RedirectURI", # required
  connection_token: "ParticipantToken", # required
})

Response structure


resp.authentication_url #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :session_id (required, String) —

    The sessionId provided in the authenticationInitiated event.

  • :redirect_uri (required, String) —

    The URL where the customer will be redirected after Amazon Cognito authorizes the user.

  • :connection_token (required, String) —

    The authentication token associated with the participant’s connection.

Returns:

See Also:



874
875
876
877
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 874

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

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

Retrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see [Enable persistent chat].

For security recommendations, see [Amazon Connect Chat security best practices].

If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session:

  • ‘application/vnd.amazonaws.connect.event.participant.left`

  • ‘application/vnd.amazonaws.connect.event.participant.joined`

  • ‘application/vnd.amazonaws.connect.event.chat.ended`

  • ‘application/vnd.amazonaws.connect.event.transfer.succeeded`

  • ‘application/vnd.amazonaws.connect.event.transfer.failed`

<note markdown=“1”> ‘ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

</note>

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

[1]: docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html [2]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat [3]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

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", "MESSAGE_DELIVERED", "MESSAGE_READ"
resp.transcript[0].participant_id #=> String
resp.transcript[0].display_name #=> String
resp.transcript[0].participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT", "SUPERVISOR"
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.transcript[0].message_metadata.message_id #=> String
resp.transcript[0].message_metadata.receipts #=> Array
resp.transcript[0].message_metadata.receipts[0].delivered_timestamp #=> String
resp.transcript[0].message_metadata.receipts[0].read_timestamp #=> String
resp.transcript[0].message_metadata.receipts[0].recipient_participant_id #=> String
resp.transcript[0].related_contact_id #=> String
resp.transcript[0].contact_id #=> String
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:



994
995
996
997
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 994

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

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

<note markdown=“1”> The ‘application/vnd.amazonaws.connect.event.connection.acknowledged` ContentType will no longer be supported starting December 31, 2024. This event has been migrated to the [CreateParticipantConnection] API using the `ConnectParticipant` field.

</note>

Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception.

For security recommendations, see [Amazon Connect Chat security best practices].

<note markdown=“1”> ‘ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

</note>

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

[1]: docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html [2]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat [3]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

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 (will be deprecated on December 31, 2024)

    • application/vnd.amazonaws.connect.event.message.delivered

    • application/vnd.amazonaws.connect.event.message.read

  • :content (String) —

    The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.

    Sample Content: “\”messageId\“:\”11111111-aaaa-bbbb-cccc-EXAMPLE01234\“”

  • :client_token (String) —

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

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

    [1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

  • :connection_token (required, String) —

    The authentication token associated with the participant’s connection.

Returns:

See Also:



1088
1089
1090
1091
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 1088

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

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

Sends a message.

For security recommendations, see [Amazon Connect Chat security best practices].

<note markdown=“1”> ‘ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

</note>

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

[1]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

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`, `text/markdown`, `application/json`, and `application/vnd.amazonaws.connect.message.interactive.response`.

  • :content (required, String) —

    The content of the message.

    • For ‘text/plain` and `text/markdown`, the Length Constraints are Minimum of 1, Maximum of 1024.

    • For ‘application/json`, the Length Constraints are Minimum of 1, Maximum of 12000.

    • For ‘application/vnd.amazonaws.connect.message.interactive.response`, the Length Constraints are Minimum of 1, Maximum of 12288.

  • :client_token (String) —

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

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

    [1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

  • :connection_token (required, String) —

    The authentication token associated with the connection.

Returns:

See Also:



1168
1169
1170
1171
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 1168

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.

For security recommendations, see [Amazon Connect Chat security best practices].

<note markdown=“1”> ‘ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

</note>

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

[1]: docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html

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

    [1]: docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html

  • :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 that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs].

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

    [1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

  • :connection_token (required, String) —

    The authentication token associated with the participant’s connection.

Returns:

See Also:



1251
1252
1253
1254
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 1251

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1280
1281
1282
 
# File 'lib/aws-sdk-connectparticipant/client.rb', line 1280

def waiter_names
  []
end