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_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_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.
-
#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_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.
410 411 412 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_encoder_configuration(params = {}) ⇒ Types::CreateEncoderConfigurationResponse
Creates an EncoderConfiguration object.
470 471 472 473 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 470 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.
538 539 540 541 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 538 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).
609 610 611 612 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 609 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.
665 666 667 668 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 665 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.
688 689 690 691 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 688 def delete_encoder_configuration(params = {}, = {}) req = build_request(:delete_encoder_configuration, params) req.send_request() end |
#delete_stage(params = {}) ⇒ Struct
Shuts down and deletes the specified stage (disconnecting all participants).
711 712 713 714 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 711 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.
739 740 741 742 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 739 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.
771 772 773 774 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 771 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.
833 834 835 836 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 833 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.
868 869 870 871 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 868 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.
917 918 919 920 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 917 def get_participant(params = {}, = {}) req = build_request(:get_participant, params) req.send_request() end |
#get_stage(params = {}) ⇒ Types::GetStageResponse
Gets information for the specified stage.
949 950 951 952 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 949 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.
983 984 985 986 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 983 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.
1015 1016 1017 1018 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1015 def get_storage_configuration(params = {}, = {}) req = build_request(:get_storage_configuration, 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.
1074 1075 1076 1077 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1074 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.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1116 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.
1172 1173 1174 1175 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1172 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.
1242 1243 1244 1245 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1242 def list_participants(params = {}, = {}) req = build_request(:list_participants, 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.
1286 1287 1288 1289 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1286 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.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1329 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.
1373 1374 1375 1376 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1373 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.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1402 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.
1546 1547 1548 1549 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1546 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.
1569 1570 1571 1572 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1569 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.
1605 1606 1607 1608 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1605 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.
1639 1640 1641 1642 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1639 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_stage(params = {}) ⇒ Types::UpdateStageResponse
Updates a stage’s configuration.
1675 1676 1677 1678 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1675 def update_stage(params = {}, = {}) req = build_request(:update_stage, params) req.send_request() end |