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

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

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

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



365
366
367
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 365

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({
  attributes: {
    "String" => "String",
  },
  capabilities: ["SEND_MESSAGE"], # accepts SEND_MESSAGE, DISCONNECT_USER, DELETE_MESSAGE
  room_identifier: "RoomIdentifier", # required
  session_duration_in_minutes: 1,
  user_id: "UserID", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

  • :room_identifier (required, String)

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

  • :session_duration_in_minutes (Integer)

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

  • :user_id (required, String)

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

Returns:

See Also:



439
440
441
442
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 439

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({
  destination_configuration: { # required
    cloud_watch_logs: {
      log_group_name: "LogGroupName", # required
    },
    firehose: {
      delivery_stream_name: "DeliveryStreamName", # required
    },
    s3: {
      bucket_name: "BucketName", # required
    },
  },
  name: "LoggingConfigurationName",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :name (String)

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

  • :tags (Hash<String,String>)

    Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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:



516
517
518
519
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 516

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({
  logging_configuration_identifiers: ["LoggingConfigurationIdentifier"],
  maximum_message_length: 1,
  maximum_message_rate_per_second: 1,
  message_review_handler: {
    fallback_result: "ALLOW", # accepts ALLOW, DENY
    uri: "LambdaArn",
  },
  name: "RoomName",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :logging_configuration_identifiers (Array<String>)

    Array of logging-configuration identifiers attached to the room.

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

  • :maximum_message_rate_per_second (Integer)

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

  • :message_review_handler (Types::MessageReviewHandler)

    Configuration information for optional review of messages.

  • :name (String)

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

  • :tags (Hash<String,String>)

    Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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:

See Also:



601
602
603
604
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 601

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:



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

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({
  id: "MessageID", # required
  reason: "Reason",
  room_identifier: "RoomIdentifier", # required
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :room_identifier (required, String)

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

Returns:

See Also:



674
675
676
677
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 674

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:



696
697
698
699
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 696

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({
  reason: "Reason",
  room_identifier: "RoomIdentifier", # required
  user_id: "UserID", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :reason (String)

    Reason for disconnecting the user.

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String)

    Identifier of the logging configuration to be retrieved.

Returns:

See Also:



778
779
780
781
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 778

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.create_time #=> Time
resp.id #=> String
resp.logging_configuration_identifiers #=> Array
resp.logging_configuration_identifiers[0] #=> String
resp.maximum_message_length #=> Integer
resp.maximum_message_rate_per_second #=> Integer
resp.message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
resp.message_review_handler.uri #=> String
resp.name #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.update_time #=> Time

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:



828
829
830
831
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 828

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({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.logging_configurations #=> Array
resp.logging_configurations[0].arn #=> String
resp.logging_configurations[0].create_time #=> Time
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].destination_configuration.s3.bucket_name #=> String
resp.logging_configurations[0].id #=> String
resp.logging_configurations[0].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.logging_configurations[0].update_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer)

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

  • :next_token (String)

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

Returns:

See Also:



877
878
879
880
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 877

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({
  logging_configuration_identifier: "LoggingConfigurationIdentifier",
  max_results: 1,
  message_review_handler_uri: "LambdaArn",
  name: "RoomName",
  next_token: "PaginationToken",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :logging_configuration_identifier (String)

    Logging-configuration identifier.

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

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

Returns:

See Also:



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

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:



968
969
970
971
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 968

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({
  attributes: {
    "String" => "String",
  },
  event_name: "EventName", # required
  room_identifier: "RoomIdentifier", # required
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :event_name (required, String)

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

  • :room_identifier (required, String)

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

Returns:

See Also:



1010
1011
1012
1013
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1010

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 Tagging AWS Resources 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:



1046
1047
1048
1049
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1046

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 Tagging AWS Resources 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:



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

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({
  destination_configuration: {
    cloud_watch_logs: {
      log_group_name: "LogGroupName", # required
    },
    firehose: {
      delivery_stream_name: "DeliveryStreamName", # required
    },
    s3: {
      bucket_name: "BucketName", # required
    },
  },
  identifier: "LoggingConfigurationIdentifier", # required
  name: "LoggingConfigurationName",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :identifier (required, String)

    Identifier of the logging configuration to be updated.

  • :name (String)

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

Returns:

See Also:



1146
1147
1148
1149
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1146

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
  logging_configuration_identifiers: ["LoggingConfigurationIdentifier"],
  maximum_message_length: 1,
  maximum_message_rate_per_second: 1,
  message_review_handler: {
    fallback_result: "ALLOW", # accepts ALLOW, DENY
    uri: "LambdaArn",
  },
  name: "RoomName",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String)

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

  • :logging_configuration_identifiers (Array<String>)

    Array of logging-configuration identifiers attached to the room.

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

  • :maximum_message_rate_per_second (Integer)

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

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

  • :name (String)

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

Returns:

See Also:



1223
1224
1225
1226
# File 'gems/aws-sdk-ivschat/lib/aws-sdk-ivschat/client.rb', line 1223

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