Class: Aws::Ivschat::Client

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

Overview

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

client = Aws::Ivschat::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 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):

  • :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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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['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)
  • :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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

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

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

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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::Ivschat::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Ivschat::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 'http://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.



473
474
475
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#create_chat_token(params = {}) ⇒ Types::CreateChatTokenResponse

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

Use the capabilities field to permit an end user to send messages or moderate a room.

The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.

Encryption keys are owned by Amazon IVS Chat and never used directly by your application.

Examples:

Request syntax with placeholder values


resp = client.create_chat_token({
  room_identifier: "RoomIdentifier", # required
  user_id: "UserID", # required
  capabilities: ["SEND_MESSAGE"], # accepts SEND_MESSAGE, DISCONNECT_USER, DELETE_MESSAGE
  session_duration_in_minutes: 1,
  attributes: {
    "String" => "String",
  },
})

Response structure


resp.token #=> String
resp.token_expiration_time #=> Time
resp.session_expiration_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :room_identifier (required, String) —

    Identifier of the room that the client is trying to access. Currently this must be an ARN.

  • :user_id (required, String) —

    Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

  • :capabilities (Array<String>) —

    Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

  • :session_duration_in_minutes (Integer) —

    Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

  • :attributes (Hash<String,String>) —

    Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

Returns:

See Also:



547
548
549
550
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 547

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

#create_logging_configuration(params = {}) ⇒ Types::CreateLoggingConfigurationResponse

Creates a logging configuration that allows clients to store and record sent messages.

Examples:

Request syntax with placeholder values


resp = client.create_logging_configuration({
  name: "LoggingConfigurationName",
  destination_configuration: { # required
    s3: {
      bucket_name: "BucketName", # required
    },
    cloud_watch_logs: {
      log_group_name: "LogGroupName", # required
    },
    firehose: {
      delivery_stream_name: "DeliveryStreamName", # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.create_time #=> Time
resp.update_time #=> Time
resp.name #=> String
resp.destination_configuration.s3.bucket_name #=> String
resp.destination_configuration.cloud_watch_logs.log_group_name #=> String
resp.destination_configuration.firehose.delivery_stream_name #=> String
resp.state #=> String, one of "ACTIVE"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    Logging-configuration name. The value does not need to be unique.

  • :destination_configuration (required, Types::DestinationConfiguration) —

    A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

  • :tags (Hash<String,String>) —

    Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented there.

Returns:

See Also:



625
626
627
628
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 625

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

#create_room(params = {}) ⇒ Types::CreateRoomResponse

Creates a room that allows clients to connect and pass messages.

Examples:

Request syntax with placeholder values


resp = client.create_room({
  name: "RoomName",
  maximum_message_rate_per_second: 1,
  maximum_message_length: 1,
  message_review_handler: {
    uri: "LambdaArn",
    fallback_result: "ALLOW", # accepts ALLOW, DENY
  },
  tags: {
    "TagKey" => "TagValue",
  },
  logging_configuration_identifiers: ["LoggingConfigurationIdentifier"],
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.name #=> String
resp.create_time #=> Time
resp.update_time #=> Time
resp.maximum_message_rate_per_second #=> Integer
resp.maximum_message_length #=> Integer
resp.message_review_handler.uri #=> String
resp.message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.logging_configuration_identifiers #=> Array
resp.logging_configuration_identifiers[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    Room name. The value does not need to be unique.

  • :maximum_message_rate_per_second (Integer) —

    Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

  • :maximum_message_length (Integer) —

    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

  • :message_review_handler (Types::MessageReviewHandler) —

    Configuration information for optional review of messages.

  • :tags (Hash<String,String>) —

    Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

  • :logging_configuration_identifiers (Array<String>) —

    Array of logging-configuration identifiers attached to the room.

Returns:

See Also:



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

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

#delete_logging_configuration(params = {}) ⇒ Struct

Deletes the specified logging configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_logging_configuration({
  identifier: "LoggingConfigurationIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    Identifier of the logging configuration to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



733
734
735
736
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 733

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

#delete_message(params = {}) ⇒ Types::DeleteMessageResponse

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

Examples:

Request syntax with placeholder values


resp = client.delete_message({
  room_identifier: "RoomIdentifier", # required
  id: "MessageID", # required
  reason: "Reason",
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :room_identifier (required, String) —

    Identifier of the room where the message should be deleted. Currently this must be an ARN.

  • :id (required, String) —

    ID of the message to be deleted. This is the Id field in the received message (see Message (Subscribe) in the Chat Messaging API).

  • :reason (String) —

    Reason for deleting the message.

Returns:

See Also:



784
785
786
787
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 784

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

#delete_room(params = {}) ⇒ Struct

Deletes the specified room.

Examples:

Request syntax with placeholder values


resp = client.delete_room({
  identifier: "RoomIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    Identifier of the room to be deleted. Currently this must be an ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



806
807
808
809
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 806

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

#disconnect_user(params = {}) ⇒ Struct

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Examples:

Request syntax with placeholder values


resp = client.disconnect_user({
  room_identifier: "RoomIdentifier", # required
  user_id: "UserID", # required
  reason: "Reason",
})

Parameters:

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

    ({})

Options Hash (params):

  • :room_identifier (required, String) —

    Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.

  • :user_id (required, String) —

    ID of the user (connection) to disconnect from the room.

  • :reason (String) —

    Reason for disconnecting the user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



843
844
845
846
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 843

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

#get_logging_configuration(params = {}) ⇒ Types::GetLoggingConfigurationResponse

Gets the specified logging configuration.

Examples:

Request syntax with placeholder values


resp = client.get_logging_configuration({
  identifier: "LoggingConfigurationIdentifier", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.create_time #=> Time
resp.update_time #=> Time
resp.name #=> String
resp.destination_configuration.s3.bucket_name #=> String
resp.destination_configuration.cloud_watch_logs.log_group_name #=> String
resp.destination_configuration.firehose.delivery_stream_name #=> String
resp.state #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "ACTIVE"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    Identifier of the logging configuration to be retrieved.

Returns:

See Also:



888
889
890
891
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 888

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

#get_room(params = {}) ⇒ Types::GetRoomResponse

Gets the specified room.

Examples:

Request syntax with placeholder values


resp = client.get_room({
  identifier: "RoomIdentifier", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.name #=> String
resp.create_time #=> Time
resp.update_time #=> Time
resp.maximum_message_rate_per_second #=> Integer
resp.maximum_message_length #=> Integer
resp.message_review_handler.uri #=> String
resp.message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.logging_configuration_identifiers #=> Array
resp.logging_configuration_identifiers[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.

Returns:

See Also:



938
939
940
941
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 938

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

#list_logging_configurations(params = {}) ⇒ Types::ListLoggingConfigurationsResponse

Gets summary information about all your logging configurations in the AWS region where the API request is processed.

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

Examples:

Request syntax with placeholder values


resp = client.list_logging_configurations({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.logging_configurations #=> Array
resp.logging_configurations[0].arn #=> String
resp.logging_configurations[0].id #=> String
resp.logging_configurations[0].create_time #=> Time
resp.logging_configurations[0].update_time #=> Time
resp.logging_configurations[0].name #=> String
resp.logging_configurations[0].destination_configuration.s3.bucket_name #=> String
resp.logging_configurations[0].destination_configuration.cloud_watch_logs.log_group_name #=> String
resp.logging_configurations[0].destination_configuration.firehose.delivery_stream_name #=> String
resp.logging_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "ACTIVE"
resp.logging_configurations[0].tags #=> Hash
resp.logging_configurations[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The first logging configurations to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of logging configurations to return. Default: 50.

Returns:

See Also:



987
988
989
990
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 987

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

#list_rooms(params = {}) ⇒ Types::ListRoomsResponse

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

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

Examples:

Request syntax with placeholder values


resp = client.list_rooms({
  name: "RoomName",
  next_token: "PaginationToken",
  max_results: 1,
  message_review_handler_uri: "LambdaArn",
  logging_configuration_identifier: "LoggingConfigurationIdentifier",
})

Response structure


resp.rooms #=> Array
resp.rooms[0].arn #=> String
resp.rooms[0].id #=> String
resp.rooms[0].name #=> String
resp.rooms[0].message_review_handler.uri #=> String
resp.rooms[0].message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
resp.rooms[0].create_time #=> Time
resp.rooms[0].update_time #=> Time
resp.rooms[0].tags #=> Hash
resp.rooms[0].tags["TagKey"] #=> String
resp.rooms[0].logging_configuration_identifiers #=> Array
resp.rooms[0].logging_configuration_identifiers[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    Filters the list to match the specified room name.

  • :next_token (String) —

    The first room to retrieve. This is used for pagination; see the nextToken response field.

  • :max_results (Integer) —

    Maximum number of rooms to return. Default: 50.

  • :message_review_handler_uri (String) —

    Filters the list to match the specified message review handler URI.

  • :logging_configuration_identifier (String) —

    Logging-configuration identifier.

Returns:

See Also:



1049
1050
1051
1052
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1049

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Gets information about AWS tags for the specified ARN.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to be retrieved. The ARN must be URL-encoded.

Returns:

See Also:



1078
1079
1080
1081
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1078

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

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

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

Examples:

Request syntax with placeholder values


resp = client.send_event({
  room_identifier: "RoomIdentifier", # required
  event_name: "EventName", # required
  attributes: {
    "String" => "String",
  },
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :room_identifier (required, String) —

    Identifier of the room to which the event will be sent. Currently this must be an ARN.

  • :event_name (required, String) —

    Application-defined name of the event to send to clients.

  • :attributes (Hash<String,String>) —

    Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.

Returns:

See Also:



1120
1121
1122
1123
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1120

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

#tag_resource(params = {}) ⇒ Struct

Adds or updates tags for the AWS resource with the specified ARN.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to be tagged. The ARN must be URL-encoded.

  • :tags (required, Hash<String,String>) —

    Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1157
1158
1159
1160
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1157

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from the resource with the specified ARN.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to be untagged. The ARN must be URL-encoded.

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

    Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1192
1193
1194
1195
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1192

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

#update_logging_configuration(params = {}) ⇒ Types::UpdateLoggingConfigurationResponse

Updates a specified logging configuration.

Examples:

Request syntax with placeholder values


resp = client.update_logging_configuration({
  identifier: "LoggingConfigurationIdentifier", # required
  name: "LoggingConfigurationName",
  destination_configuration: {
    s3: {
      bucket_name: "BucketName", # required
    },
    cloud_watch_logs: {
      log_group_name: "LogGroupName", # required
    },
    firehose: {
      delivery_stream_name: "DeliveryStreamName", # required
    },
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.create_time #=> Time
resp.update_time #=> Time
resp.name #=> String
resp.destination_configuration.s3.bucket_name #=> String
resp.destination_configuration.cloud_watch_logs.log_group_name #=> String
resp.destination_configuration.firehose.delivery_stream_name #=> String
resp.state #=> String, one of "ACTIVE"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    Identifier of the logging configuration to be updated.

  • :name (String) —

    Logging-configuration name. The value does not need to be unique.

  • :destination_configuration (Types::DestinationConfiguration) —

    A complex type that contains a destination configuration for where chat content will be logged. There can be only one type of destination (cloudWatchLogs, firehose, or s3) in a destinationConfiguration.

Returns:

See Also:



1258
1259
1260
1261
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1258

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

#update_room(params = {}) ⇒ Types::UpdateRoomResponse

Updates a room’s configuration.

Examples:

Request syntax with placeholder values


resp = client.update_room({
  identifier: "RoomIdentifier", # required
  name: "RoomName",
  maximum_message_rate_per_second: 1,
  maximum_message_length: 1,
  message_review_handler: {
    uri: "LambdaArn",
    fallback_result: "ALLOW", # accepts ALLOW, DENY
  },
  logging_configuration_identifiers: ["LoggingConfigurationIdentifier"],
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.name #=> String
resp.create_time #=> Time
resp.update_time #=> Time
resp.maximum_message_rate_per_second #=> Integer
resp.maximum_message_length #=> Integer
resp.message_review_handler.uri #=> String
resp.message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.logging_configuration_identifiers #=> Array
resp.logging_configuration_identifiers[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    Identifier of the room to be updated. Currently this must be an ARN.

  • :name (String) —

    Room name. The value does not need to be unique.

  • :maximum_message_rate_per_second (Integer) —

    Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

  • :maximum_message_length (Integer) —

    The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

  • :message_review_handler (Types::MessageReviewHandler) —

    Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.

  • :logging_configuration_identifiers (Array<String>) —

    Array of logging-configuration identifiers attached to the room.

Returns:

See Also:



1335
1336
1337
1338
 
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1335

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