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_ingest_configuration(params = {}) ⇒ Types::CreateIngestConfigurationResponse
Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
-
#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_ingest_configuration(params = {}) ⇒ Struct
Deletes a specified IngestConfiguration, so it can no longer be used to broadcast.
-
#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 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_ingest_configuration(params = {}) ⇒ Types::GetIngestConfigurationResponse
Gets information about the specified IngestConfiguration.
-
#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_ingest_configurations(params = {}) ⇒ Types::ListIngestConfigurationsResponse
Lists all IngestConfigurations 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_ingest_configuration(params = {}) ⇒ Types::UpdateIngestConfigurationResponse
Updates a specified IngestConfiguration.
-
#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.
466 467 468 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#create_encoder_configuration(params = {}) ⇒ Types::CreateEncoderConfigurationResponse
Creates an EncoderConfiguration object.
527 528 529 530 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 527 def create_encoder_configuration(params = {}, = {}) req = build_request(:create_encoder_configuration, params) req.send_request() end |
#create_ingest_configuration(params = {}) ⇒ Types::CreateIngestConfigurationResponse
Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
616 617 618 619 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 616 def create_ingest_configuration(params = {}, = {}) req = build_request(:create_ingest_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.
684 685 686 687 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 684 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).
786 787 788 789 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 786 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.
843 844 845 846 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 843 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.
866 867 868 869 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 866 def delete_encoder_configuration(params = {}, = {}) req = build_request(:delete_encoder_configuration, params) req.send_request() end |
#delete_ingest_configuration(params = {}) ⇒ Struct
Deletes a specified IngestConfiguration, so it can no longer be used
to broadcast. An IngestConfiguration cannot be deleted if the
publisher is actively streaming to a stage, unless force
is set to
true
.
898 899 900 901 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 898 def delete_ingest_configuration(params = {}, = {}) req = build_request(:delete_ingest_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.
922 923 924 925 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 922 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). This operation also removes the stageArn
from the
associated IngestConfiguration, if there are participants using the
IngestConfiguration to publish to the stage.
947 948 949 950 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 947 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.
975 976 977 978 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 975 def delete_storage_configuration(params = {}, = {}) req = build_request(:delete_storage_configuration, params) req.send_request() end |
#disconnect_participant(params = {}) ⇒ Struct
Disconnects a specified participant from a specified stage. If the
participant is publishing using an IngestConfiguration,
DisconnectParticipant also updates the stageArn
in the
IngestConfiguration to be an empty string.
1010 1011 1012 1013 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1010 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.
1077 1078 1079 1080 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1077 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.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1112 def get_encoder_configuration(params = {}, = {}) req = build_request(:get_encoder_configuration, params) req.send_request() end |
#get_ingest_configuration(params = {}) ⇒ Types::GetIngestConfigurationResponse
Gets information about the specified IngestConfiguration.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1151 def get_ingest_configuration(params = {}, = {}) req = build_request(:get_ingest_configuration, params) req.send_request() end |
#get_participant(params = {}) ⇒ Types::GetParticipantResponse
Gets information about the specified participant token.
1204 1205 1206 1207 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1204 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.
1237 1238 1239 1240 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1237 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.
1282 1283 1284 1285 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1282 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.
1316 1317 1318 1319 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1316 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.
1348 1349 1350 1351 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1348 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.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1400 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.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1459 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.
1501 1502 1503 1504 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1501 def list_encoder_configurations(params = {}, = {}) req = build_request(:list_encoder_configurations, params) req.send_request() end |
#list_ingest_configurations(params = {}) ⇒ Types::ListIngestConfigurationsResponse
Lists all IngestConfigurations 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.
1556 1557 1558 1559 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1556 def list_ingest_configurations(params = {}, = {}) req = build_request(:list_ingest_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.
1612 1613 1614 1615 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1612 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.
1692 1693 1694 1695 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1692 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.
1734 1735 1736 1737 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1734 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.
1778 1779 1780 1781 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1778 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.
1821 1822 1823 1824 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1821 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.
1865 1866 1867 1868 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1865 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.
1894 1895 1896 1897 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 1894 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 operation 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.
2054 2055 2056 2057 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 2054 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.
2077 2078 2079 2080 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 2077 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.
2114 2115 2116 2117 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 2114 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.
2148 2149 2150 2151 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 2148 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_ingest_configuration(params = {}) ⇒ Types::UpdateIngestConfigurationResponse
Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.
2194 2195 2196 2197 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 2194 def update_ingest_configuration(params = {}, = {}) req = build_request(:update_ingest_configuration, params) req.send_request() end |
#update_stage(params = {}) ⇒ Types::UpdateStageResponse
Updates a stage’s configuration.
2261 2262 2263 2264 |
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/client.rb', line 2261 def update_stage(params = {}, = {}) req = build_request(:update_stage, params) req.send_request() end |