Class: Aws::IVSRealTime::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IVSRealTime::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb
Overview
An API client for IVSRealTime. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IVSRealTime::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
API Operations collapse
-
#create_encoder_configuration(params = {}) ⇒ Types::CreateEncoderConfigurationResponse
Creates an EncoderConfiguration object.
-
#create_participant_token(params = {}) ⇒ Types::CreateParticipantTokenResponse
Creates an additional token for a specified stage.
-
#create_stage(params = {}) ⇒ Types::CreateStageResponse
Creates a new stage (and optionally participant tokens).
-
#create_storage_configuration(params = {}) ⇒ Types::CreateStorageConfigurationResponse
Creates a new storage configuration, used to enable recording to Amazon S3.
-
#delete_encoder_configuration(params = {}) ⇒ Struct
Deletes an EncoderConfiguration resource.
-
#delete_public_key(params = {}) ⇒ Struct
Deletes the specified public key used to sign stage participant tokens.
-
#delete_stage(params = {}) ⇒ Struct
Shuts down and deletes the specified stage (disconnecting all participants).
-
#delete_storage_configuration(params = {}) ⇒ Struct
Deletes the storage configuration for the specified ARN.
-
#disconnect_participant(params = {}) ⇒ Struct
Disconnects a specified participant and revokes the participant permanently from a specified stage.
-
#get_composition(params = {}) ⇒ Types::GetCompositionResponse
Get information about the specified Composition resource.
-
#get_encoder_configuration(params = {}) ⇒ Types::GetEncoderConfigurationResponse
Gets information about the specified EncoderConfiguration resource.
-
#get_participant(params = {}) ⇒ Types::GetParticipantResponse
Gets information about the specified participant token.
-
#get_public_key(params = {}) ⇒ Types::GetPublicKeyResponse
Gets information for the specified public key.
-
#get_stage(params = {}) ⇒ Types::GetStageResponse
Gets information for the specified stage.
-
#get_stage_session(params = {}) ⇒ Types::GetStageSessionResponse
Gets information for the specified stage session.
-
#get_storage_configuration(params = {}) ⇒ Types::GetStorageConfigurationResponse
Gets the storage configuration for the specified ARN.
-
#import_public_key(params = {}) ⇒ Types::ImportPublicKeyResponse
Import a public key to be used for signing stage participant tokens.
-
#list_compositions(params = {}) ⇒ Types::ListCompositionsResponse
Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
-
#list_encoder_configurations(params = {}) ⇒ Types::ListEncoderConfigurationsResponse
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
-
#list_participant_events(params = {}) ⇒ Types::ListParticipantEventsResponse
Lists events for a specified participant that occurred during a specified stage session.
-
#list_participants(params = {}) ⇒ Types::ListParticipantsResponse
Lists all participants in a specified stage session.
-
#list_public_keys(params = {}) ⇒ Types::ListPublicKeysResponse
Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
-
#list_stage_sessions(params = {}) ⇒ Types::ListStageSessionsResponse
Gets all sessions for a specified stage.
-
#list_stages(params = {}) ⇒ Types::ListStagesResponse
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
-
#list_storage_configurations(params = {}) ⇒ Types::ListStorageConfigurationsResponse
Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets information about AWS tags for the specified ARN.
-
#start_composition(params = {}) ⇒ Types::StartCompositionResponse
Starts a Composition from a stage based on the configuration provided in the request.
-
#stop_composition(params = {}) ⇒ Struct
Stops and deletes a Composition resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for the AWS resource with the specified ARN.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from the resource with the specified ARN.
-
#update_stage(params = {}) ⇒ Types::UpdateStageResponse
Updates a stage’s configuration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
422 423 424 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#create_encoder_configuration(params = {}) ⇒ Types::CreateEncoderConfigurationResponse
Creates an EncoderConfiguration object.
482 483 484 485 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 482 def create_encoder_configuration(params = {}, = {}) req = build_request(:create_encoder_configuration, params) req.send_request() end |
#create_participant_token(params = {}) ⇒ Types::CreateParticipantTokenResponse
Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
550 551 552 553 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 550 def create_participant_token(params = {}, = {}) req = build_request(:create_participant_token, params) req.send_request() end |
#create_stage(params = {}) ⇒ Types::CreateStageResponse
Creates a new stage (and optionally participant tokens).
634 635 636 637 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 634 def create_stage(params = {}, = {}) req = build_request(:create_stage, params) req.send_request() end |
#create_storage_configuration(params = {}) ⇒ Types::CreateStorageConfigurationResponse
Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.
690 691 692 693 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 690 def create_storage_configuration(params = {}, = {}) req = build_request(:create_storage_configuration, params) req.send_request() end |
#delete_encoder_configuration(params = {}) ⇒ Struct
Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
713 714 715 716 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 713 def delete_encoder_configuration(params = {}, = {}) req = build_request(:delete_encoder_configuration, params) req.send_request() end |
#delete_public_key(params = {}) ⇒ Struct
Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.
737 738 739 740 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 737 def delete_public_key(params = {}, = {}) req = build_request(:delete_public_key, params) req.send_request() end |
#delete_stage(params = {}) ⇒ Struct
Shuts down and deletes the specified stage (disconnecting all participants).
760 761 762 763 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 760 def delete_stage(params = {}, = {}) req = build_request(:delete_stage, params) req.send_request() end |
#delete_storage_configuration(params = {}) ⇒ Struct
Deletes the storage configuration for the specified ARN.
If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.
788 789 790 791 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 788 def delete_storage_configuration(params = {}, = {}) req = build_request(:delete_storage_configuration, params) req.send_request() end |
#disconnect_participant(params = {}) ⇒ Struct
Disconnects a specified participant and revokes the participant permanently from a specified stage.
820 821 822 823 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 820 def disconnect_participant(params = {}, = {}) req = build_request(:disconnect_participant, params) req.send_request() end |
#get_composition(params = {}) ⇒ Types::GetCompositionResponse
Get information about the specified Composition resource.
882 883 884 885 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 882 def get_composition(params = {}, = {}) req = build_request(:get_composition, params) req.send_request() end |
#get_encoder_configuration(params = {}) ⇒ Types::GetEncoderConfigurationResponse
Gets information about the specified EncoderConfiguration resource.
917 918 919 920 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 917 def get_encoder_configuration(params = {}, = {}) req = build_request(:get_encoder_configuration, params) req.send_request() end |
#get_participant(params = {}) ⇒ Types::GetParticipantResponse
Gets information about the specified participant token.
969 970 971 972 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 969 def get_participant(params = {}, = {}) req = build_request(:get_participant, params) req.send_request() end |
#get_public_key(params = {}) ⇒ Types::GetPublicKeyResponse
Gets information for the specified public key.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1002 def get_public_key(params = {}, = {}) req = build_request(:get_public_key, params) req.send_request() end |
#get_stage(params = {}) ⇒ Types::GetStageResponse
Gets information for the specified stage.
1039 1040 1041 1042 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1039 def get_stage(params = {}, = {}) req = build_request(:get_stage, params) req.send_request() end |
#get_stage_session(params = {}) ⇒ Types::GetStageSessionResponse
Gets information for the specified stage session.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1073 def get_stage_session(params = {}, = {}) req = build_request(:get_stage_session, params) req.send_request() end |
#get_storage_configuration(params = {}) ⇒ Types::GetStorageConfigurationResponse
Gets the storage configuration for the specified ARN.
1105 1106 1107 1108 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1105 def get_storage_configuration(params = {}, = {}) req = build_request(:get_storage_configuration, params) req.send_request() end |
#import_public_key(params = {}) ⇒ Types::ImportPublicKeyResponse
Import a public key to be used for signing stage participant tokens.
1156 1157 1158 1159 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1156 def import_public_key(params = {}, = {}) req = build_request(:import_public_key, params) req.send_request() end |
#list_compositions(params = {}) ⇒ Types::ListCompositionsResponse
Gets summary information about all Compositions in your account, 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.
1215 1216 1217 1218 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1215 def list_compositions(params = {}, = {}) req = build_request(:list_compositions, params) req.send_request() end |
#list_encoder_configurations(params = {}) ⇒ Types::ListEncoderConfigurationsResponse
Gets summary information about all EncoderConfigurations in your account, 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.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1257 def list_encoder_configurations(params = {}, = {}) req = build_request(:list_encoder_configurations, params) req.send_request() end |
#list_participant_events(params = {}) ⇒ Types::ListParticipantEventsResponse
Lists events for a specified participant that occurred during a specified stage session.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1313 1314 1315 1316 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1313 def list_participant_events(params = {}, = {}) req = build_request(:list_participant_events, params) req.send_request() end |
#list_participants(params = {}) ⇒ Types::ListParticipantsResponse
Lists all participants in a specified stage session.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1393 1394 1395 1396 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1393 def list_participants(params = {}, = {}) req = build_request(:list_participants, params) req.send_request() end |
#list_public_keys(params = {}) ⇒ Types::ListPublicKeysResponse
Gets summary information about all public keys in your account, 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.
1435 1436 1437 1438 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1435 def list_public_keys(params = {}, = {}) req = build_request(:list_public_keys, params) req.send_request() end |
#list_stage_sessions(params = {}) ⇒ Types::ListStageSessionsResponse
Gets all sessions for a specified stage.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1479 1480 1481 1482 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1479 def list_stage_sessions(params = {}, = {}) req = build_request(:list_stage_sessions, params) req.send_request() end |
#list_stages(params = {}) ⇒ Types::ListStagesResponse
Gets summary information about all stages in your account, 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.
1522 1523 1524 1525 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1522 def list_stages(params = {}, = {}) req = build_request(:list_stages, params) req.send_request() end |
#list_storage_configurations(params = {}) ⇒ Types::ListStorageConfigurationsResponse
Gets summary information about all storage configurations in your account, 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.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1566 def list_storage_configurations(params = {}, = {}) req = build_request(:list_storage_configurations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets information about AWS tags for the specified ARN.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1595 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_composition(params = {}) ⇒ Types::StartCompositionResponse
Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted:
When StopComposition is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.
1739 1740 1741 1742 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1739 def start_composition(params = {}, = {}) req = build_request(:start_composition, params) req.send_request() end |
#stop_composition(params = {}) ⇒ Struct
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
1762 1763 1764 1765 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1762 def stop_composition(params = {}, = {}) req = build_request(:stop_composition, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for the AWS resource with the specified ARN.
1798 1799 1800 1801 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1798 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the resource with the specified ARN.
1832 1833 1834 1835 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1832 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_stage(params = {}) ⇒ Types::UpdateStageResponse
Updates a stage’s configuration.
1882 1883 1884 1885 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1882 def update_stage(params = {}, = {}) req = build_request(:update_stage, params) req.send_request() end |