IVS
***


Client
======

class IVS.Client

   A low-level client representing Amazon Interactive Video Service
   (IVS)

   **Introduction**

   The Amazon Interactive Video Service (IVS) API is REST compatible,
   using a standard HTTP API and an Amazon Web Services EventBridge
   event stream for responses. JSON is used for both requests and
   responses, including errors.

   The API is an Amazon Web Services regional service. For a list of
   supported regions and Amazon IVS HTTPS service endpoints, see the
   Amazon IVS page in the *Amazon Web Services General Reference*.

   **All API request parameters and URLs are case sensitive.**

   For a summary of notable documentation changes in each release, see
   Document History.

   **Allowed Header Values**

   * "**Accept:**" application/json

   * "**Accept-Encoding:**" gzip, deflate

   * >>``<<**Content-Type:** >>``<<application/json

   **Key Concepts**

   * **Channel** — Stores configuration data related to your live
     stream. You first create a channel and then use the channel’s
     stream key to start your live stream.

   * **Stream key** — An identifier assigned by Amazon IVS when you
     create a channel, which is then used to authorize streaming.
     **Treat the stream key like a secret, since it allows anyone to
     stream to the channel.**

   * **Playback key pair** — Video playback may be restricted using
     playback-authorization tokens, which use public-key encryption. A
     playback key pair is the public-private pair of keys used to sign
     and validate the playback-authorization token.

   * **Recording configuration** — Stores configuration related to
     recording a live stream and where to store the recorded content.
     Multiple channels can reference the same recording configuration.

   * **Playback restriction policy** — Restricts playback by countries
     and/or origin sites.

   For more information about your IVS live stream, also see Getting
   Started with IVS Low-Latency Streaming.

   **Tagging**

   A *tag* is a metadata label that you assign to an Amazon Web
   Services resource. A tag comprises a *key* and a *value*, both set
   by you. For example, you might set a tag as "topic:nature" to label
   a particular video category. See Best practices and strategies in
   *Tagging Amazon Web Services Resources and Tag Editor* for details,
   including restrictions that apply to tags and "Tag naming limits
   and requirements"; Amazon IVS has no service-specific constraints
   beyond what is documented there.

   Tags can help you identify and organize your Amazon Web Services
   resources. For example, you can use the same tag for different
   resources to indicate that they are related. You can also use tags
   to manage access (see Access Tags).

   The Amazon IVS API has these tag-related operations:  TagResource,
   UntagResource, and  ListTagsForResource. The following resources
   support tagging: Channels, Stream Keys, Playback Key Pairs, and
   Recording Configurations.

   At most 50 tags can be applied to a resource.

   **Authentication versus Authorization**

   Note the differences between these concepts:

   * *Authentication* is about verifying identity. You need to be
     authenticated to sign Amazon IVS API requests.

   * *Authorization* is about granting permissions. Your IAM roles
     need to have permissions for Amazon IVS API requests. In
     addition, authorization is needed to view Amazon IVS private
     channels. (Private channels are channels that are enabled for
     "playback authorization.")

   **Authentication**

   All Amazon IVS API requests must be authenticated with a signature.
   The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS
   Player SDKs take care of signing the underlying API calls for you.
   However, if your application calls the Amazon IVS API directly,
   it’s your responsibility to sign the requests.

   You generate a signature using valid Amazon Web Services
   credentials that have permission to perform the requested action.
   For example, you must sign PutMetadata requests with a signature
   generated from a user account that has the "ivs:PutMetadata"
   permission.

   For more information:

   * Authentication and generating signatures — See Authenticating
     Requests (Amazon Web Services Signature Version 4) in the *Amazon
     Web Services General Reference*.

   * Managing Amazon IVS permissions — See Identity and Access
     Management on the Security page of the *Amazon IVS User Guide*.

   **Amazon Resource Names (ARNs)**

   ARNs uniquely identify AWS resources. An ARN is required when you
   need to specify a resource unambiguously across all of AWS, such as
   in IAM policies and API calls. For more information, see Amazon
   Resource Names in the *AWS General Reference*.

      import boto3

      client = boto3.client('ivs')

These are the available methods:

* batch_get_channel

* batch_get_stream_key

* batch_start_viewer_session_revocation

* can_paginate

* close

* create_channel

* create_playback_restriction_policy

* create_recording_configuration

* create_stream_key

* delete_channel

* delete_playback_key_pair

* delete_playback_restriction_policy

* delete_recording_configuration

* delete_stream_key

* get_channel

* get_paginator

* get_playback_key_pair

* get_playback_restriction_policy

* get_recording_configuration

* get_stream

* get_stream_key

* get_stream_session

* get_waiter

* import_playback_key_pair

* list_channels

* list_playback_key_pairs

* list_playback_restriction_policies

* list_recording_configurations

* list_stream_keys

* list_stream_sessions

* list_streams

* list_tags_for_resource

* put_metadata

* start_viewer_session_revocation

* stop_stream

* tag_resource

* untag_resource

* update_channel

* update_playback_restriction_policy


Paginators
==========

Paginators are available on a client instance via the "get_paginator"
method. For more detailed instructions and examples on the usage of
paginators, see the paginators user guide.

The available paginators are:

* ListChannels

* ListPlaybackKeyPairs

* ListRecordingConfigurations

* ListStreamKeys

* ListStreams
IVS / Paginator / ListStreams


ListStreams
***********

class IVS.Paginator.ListStreams

      paginator = client.get_paginator('list_streams')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "IVS.Client.list_streams()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             filterBy={
                 'health': 'HEALTHY'|'STARVING'|'UNKNOWN'
             },
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **filterBy** (*dict*) --

           Filters the stream list to match the specified criterion.

           * **health** *(string) --*

             The stream’s health.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'streams': [
                    {
                        'channelArn': 'string',
                        'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
                        'startTime': datetime(2015, 1, 1),
                        'state': 'LIVE'|'OFFLINE',
                        'streamId': 'string',
                        'viewerCount': 123
                    },
                ],
                'NextToken': 'string'
            }

         **Response Structure**

         * *(dict) --*

           * **streams** *(list) --*

             List of streams.

             * *(dict) --*

               Summary information about a stream.

               * **channelArn** *(string) --*

                 Channel ARN for the stream.

               * **health** *(string) --*

                 The stream’s health.

               * **startTime** *(datetime) --*

                 Time of the stream’s start. This is an ISO 8601
                 timestamp; *note that this is returned as a string*.

               * **state** *(string) --*

                 The stream’s state. Do not rely on the "OFFLINE"
                 state, as the API may not return it; instead, a
                 "NotBroadcasting" error will indicate that the stream
                 is not live.

               * **streamId** *(string) --*

                 Unique identifier for a live or previously live
                 stream in the specified channel.

               * **viewerCount** *(integer) --*

                 A count of concurrent views of the stream. Typically,
                 a new view appears in "viewerCount" within 15 seconds
                 of when video playback starts and a view is removed
                 from "viewerCount" within 1 minute of when video
                 playback ends. A value of -1 indicates that the
                 request timed out; in this case, retry.

           * **NextToken** *(string) --*

             A token to resume pagination.
IVS / Paginator / ListRecordingConfigurations


ListRecordingConfigurations
***************************

class IVS.Paginator.ListRecordingConfigurations

      paginator = client.get_paginator('list_recording_configurations')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "IVS.Client.list_recording_configurations()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         **PaginationConfig** (*dict*) --

         A dictionary that provides parameters to control pagination.

         * **MaxItems** *(integer) --*

           The total number of items to return. If the total number of
           items available is more than the value specified in max-
           items then a "NextToken" will be provided in the output
           that you can use to resume pagination.

         * **PageSize** *(integer) --*

           The size of each page.

         * **StartingToken** *(string) --*

           A token to specify where to start paginating. This is the
           "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'recordingConfigurations': [
                    {
                        'arn': 'string',
                        'destinationConfiguration': {
                            's3': {
                                'bucketName': 'string'
                            }
                        },
                        'name': 'string',
                        'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
                        'tags': {
                            'string': 'string'
                        }
                    },
                ],
                'NextToken': 'string'
            }

         **Response Structure**

         * *(dict) --*

           * **recordingConfigurations** *(list) --*

             List of the matching recording configurations.

             * *(dict) --*

               Summary information about a RecordingConfiguration.

               * **arn** *(string) --*

                 Recording-configuration ARN.

               * **destinationConfiguration** *(dict) --*

                 A complex type that contains information about where
                 recorded video will be stored.

                 * **s3** *(dict) --*

                   An S3 destination configuration where recorded
                   videos will be stored.

                   * **bucketName** *(string) --*

                     Location (S3 bucket name) where recorded videos
                     will be stored.

               * **name** *(string) --*

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

               * **state** *(string) --*

                 Indicates the current state of the recording
                 configuration. When the state is "ACTIVE", the
                 configuration is ready for recording a channel
                 stream.

               * **tags** *(dict) --*

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

                 * *(string) --*

                   * *(string) --*

           * **NextToken** *(string) --*

             A token to resume pagination.
IVS / Paginator / ListPlaybackKeyPairs


ListPlaybackKeyPairs
********************

class IVS.Paginator.ListPlaybackKeyPairs

      paginator = client.get_paginator('list_playback_key_pairs')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "IVS.Client.list_playback_key_pairs()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         **PaginationConfig** (*dict*) --

         A dictionary that provides parameters to control pagination.

         * **MaxItems** *(integer) --*

           The total number of items to return. If the total number of
           items available is more than the value specified in max-
           items then a "NextToken" will be provided in the output
           that you can use to resume pagination.

         * **PageSize** *(integer) --*

           The size of each page.

         * **StartingToken** *(string) --*

           A token to specify where to start paginating. This is the
           "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'keyPairs': [
                    {
                        'arn': 'string',
                        'name': 'string',
                        'tags': {
                            'string': 'string'
                        }
                    },
                ],
                'NextToken': 'string'
            }

         **Response Structure**

         * *(dict) --*

           * **keyPairs** *(list) --*

             List of key pairs.

             * *(dict) --*

               Summary information about a playback key pair.

               * **arn** *(string) --*

                 Key-pair ARN.

               * **name** *(string) --*

                 Playback-key-pair name. The value does not need to be
                 unique.

               * **tags** *(dict) --*

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

                 * *(string) --*

                   * *(string) --*

           * **NextToken** *(string) --*

             A token to resume pagination.
IVS / Paginator / ListChannels


ListChannels
************

class IVS.Paginator.ListChannels

      paginator = client.get_paginator('list_channels')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "IVS.Client.list_channels()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             filterByName='string',
             filterByPlaybackRestrictionPolicyArn='string',
             filterByRecordingConfigurationArn='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **filterByName** (*string*) -- Filters the channel list to
           match the specified name.

         * **filterByPlaybackRestrictionPolicyArn** (*string*) --
           Filters the channel list to match the specified policy.

         * **filterByRecordingConfigurationArn** (*string*) -- Filters
           the channel list to match the specified recording-
           configuration ARN.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'channels': [
                    {
                        'arn': 'string',
                        'authorized': True|False,
                        'insecureIngest': True|False,
                        'latencyMode': 'NORMAL'|'LOW',
                        'name': 'string',
                        'playbackRestrictionPolicyArn': 'string',
                        'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
                        'recordingConfigurationArn': 'string',
                        'tags': {
                            'string': 'string'
                        },
                        'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
                    },
                ],
                'NextToken': 'string'
            }

         **Response Structure**

         * *(dict) --*

           * **channels** *(list) --*

             List of the matching channels.

             * *(dict) --*

               Summary information about a channel.

               * **arn** *(string) --*

                 Channel ARN.

               * **authorized** *(boolean) --*

                 Whether the channel is private (enabled for playback
                 authorization). Default: "false".

               * **insecureIngest** *(boolean) --*

                 Whether the channel allows insecure RTMP ingest.
                 Default: "false".

               * **latencyMode** *(string) --*

                 Channel latency mode. Use "NORMAL" to broadcast and
                 deliver live video up to Full HD. Use "LOW" for near-
                 real-time interaction with viewers. Default: "LOW".

               * **name** *(string) --*

                 Channel name.

               * **playbackRestrictionPolicyArn** *(string) --*

                 Playback-restriction-policy ARN. A valid ARN value
                 here both specifies the ARN and enables playback
                 restriction. Default: "" (empty string, no playback
                 restriction policy is applied).

               * **preset** *(string) --*

                 Optional transcode preset for the channel. This is
                 selectable only for "ADVANCED_HD" and "ADVANCED_SD"
                 channel types. For those channel types, the default
                 "preset" is "HIGHER_BANDWIDTH_DELIVERY". For other
                 channel types ( "BASIC" and "STANDARD"), "preset" is
                 the empty string ( """").

               * **recordingConfigurationArn** *(string) --*

                 Recording-configuration ARN. A valid ARN value here
                 both specifies the ARN and enables recording.
                 Default: "" (empty string, recording is disabled).

               * **tags** *(dict) --*

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

                 * *(string) --*

                   * *(string) --*

               * **type** *(string) --*

                 Channel type, which determines the allowable
                 resolution and bitrate. *If you exceed the allowable
                 input resolution or bitrate, the stream probably will
                 disconnect immediately.* Default: "STANDARD". For
                 details, see Channel Types.

           * **NextToken** *(string) --*

             A token to resume pagination.
IVS / Paginator / ListStreamKeys


ListStreamKeys
**************

class IVS.Paginator.ListStreamKeys

      paginator = client.get_paginator('list_stream_keys')

   paginate(**kwargs)

      Creates an iterator that will paginate through responses from
      "IVS.Client.list_stream_keys()".

      See also: AWS API Documentation

      **Request Syntax**

         response_iterator = paginator.paginate(
             channelArn='string',
             PaginationConfig={
                 'MaxItems': 123,
                 'PageSize': 123,
                 'StartingToken': 'string'
             }
         )

      Parameters:
         * **channelArn** (*string*) --

           **[REQUIRED]**

           Channel ARN used to filter the list.

         * **PaginationConfig** (*dict*) --

           A dictionary that provides parameters to control
           pagination.

           * **MaxItems** *(integer) --*

             The total number of items to return. If the total number
             of items available is more than the value specified in
             max-items then a "NextToken" will be provided in the
             output that you can use to resume pagination.

           * **PageSize** *(integer) --*

             The size of each page.

           * **StartingToken** *(string) --*

             A token to specify where to start paginating. This is the
             "NextToken" from a previous response.

      Return type:
         dict

      Returns:
         **Response Syntax**

            {
                'streamKeys': [
                    {
                        'arn': 'string',
                        'channelArn': 'string',
                        'tags': {
                            'string': 'string'
                        }
                    },
                ],
                'NextToken': 'string'
            }

         **Response Structure**

         * *(dict) --*

           * **streamKeys** *(list) --*

             List of stream keys.

             * *(dict) --*

               Summary information about a stream key.

               * **arn** *(string) --*

                 Stream-key ARN.

               * **channelArn** *(string) --*

                 Channel ARN for the stream.

               * **tags** *(dict) --*

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

                 * *(string) --*

                   * *(string) --*

           * **NextToken** *(string) --*

             A token to resume pagination.
IVS / Client / get_playback_key_pair


get_playback_key_pair
*********************

IVS.Client.get_playback_key_pair(**kwargs)

   Gets a specified playback authorization key pair and returns the
   "arn" and "fingerprint". The "privateKey" held by the caller can be
   used to generate viewer authorization tokens, to grant viewers
   access to private channels. For more information, see Setting Up
   Private Channels in the *Amazon IVS User Guide*.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_playback_key_pair(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN of the key pair to be returned.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'keyPair': {
                 'arn': 'string',
                 'fingerprint': 'string',
                 'name': 'string',
                 'tags': {
                     'string': 'string'
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **keyPair** *(dict) --*

          * **arn** *(string) --*

            Key-pair ARN.

          * **fingerprint** *(string) --*

            Key-pair identifier.

          * **name** *(string) --*

            Playback-key-pair name. The value does not need to be
            unique.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / get_paginator


get_paginator
*************

IVS.Client.get_paginator(operation_name)

   Create a paginator for an operation.

   Parameters:
      **operation_name** (*string*) -- The operation name.  This is
      the same name as the method name on the client.  For example, if
      the method name is "create_foo", and you'd normally invoke the
      operation as "client.create_foo(**kwargs)", if the "create_foo"
      operation can be paginated, you can use the call
      "client.get_paginator("create_foo")".

   Raises:
      **OperationNotPageableError** -- Raised if the operation is not
      pageable.  You can use the "client.can_paginate" method to check
      if an operation is pageable.

   Return type:
      "botocore.paginate.Paginator"

   Returns:
      A paginator object.
IVS / Client / start_viewer_session_revocation


start_viewer_session_revocation
*******************************

IVS.Client.start_viewer_session_revocation(**kwargs)

   Starts the process of revoking the viewer session associated with a
   specified channel ARN and viewer ID. Optionally, you can provide a
   version to revoke viewer sessions less than and including that
   version. For instructions on associating a viewer ID with a viewer
   session, see Setting Up Private Channels.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.start_viewer_session_revocation(
          channelArn='string',
          viewerId='string',
          viewerSessionVersionsLessThanOrEqualTo=123
      )

   Parameters:
      * **channelArn** (*string*) --

        **[REQUIRED]**

        The ARN of the channel associated with the viewer session to
        revoke.

      * **viewerId** (*string*) --

        **[REQUIRED]**

        The ID of the viewer associated with the viewer session to
        revoke. Do not use this field for personally identifying,
        confidential, or sensitive information.

      * **viewerSessionVersionsLessThanOrEqualTo** (*integer*) -- An
        optional filter on which versions of the viewer session to
        revoke. All versions less than or equal to the specified
        version will be revoked. Default: 0.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.InternalServerException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ThrottlingException"
IVS / Client / delete_stream_key


delete_stream_key
*****************

IVS.Client.delete_stream_key(**kwargs)

   Deletes the stream key for the specified ARN, so it can no longer
   be used to stream.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_stream_key(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN of the stream key to be deleted.

   Returns:
      None

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"
IVS / Client / list_channels


list_channels
*************

IVS.Client.list_channels(**kwargs)

   Gets summary information about all channels in your account, in the
   Amazon Web Services region where the API request is processed. This
   list can be filtered to match a specified name or recording-
   configuration ARN. Filters are mutually exclusive and cannot be
   used together. If you try to use both filters, you will get an
   error (409 ConflictException).

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_channels(
          filterByName='string',
          filterByPlaybackRestrictionPolicyArn='string',
          filterByRecordingConfigurationArn='string',
          maxResults=123,
          nextToken='string'
      )

   Parameters:
      * **filterByName** (*string*) -- Filters the channel list to
        match the specified name.

      * **filterByPlaybackRestrictionPolicyArn** (*string*) -- Filters
        the channel list to match the specified policy.

      * **filterByRecordingConfigurationArn** (*string*) -- Filters
        the channel list to match the specified recording-
        configuration ARN.

      * **maxResults** (*integer*) -- Maximum number of channels to
        return. Default: 100.

      * **nextToken** (*string*) -- The first channel to retrieve.
        This is used for pagination; see the "nextToken" response
        field.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'channels': [
                 {
                     'arn': 'string',
                     'authorized': True|False,
                     'insecureIngest': True|False,
                     'latencyMode': 'NORMAL'|'LOW',
                     'name': 'string',
                     'playbackRestrictionPolicyArn': 'string',
                     'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
                     'recordingConfigurationArn': 'string',
                     'tags': {
                         'string': 'string'
                     },
                     'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
                 },
             ],
             'nextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **channels** *(list) --*

          List of the matching channels.

          * *(dict) --*

            Summary information about a channel.

            * **arn** *(string) --*

              Channel ARN.

            * **authorized** *(boolean) --*

              Whether the channel is private (enabled for playback
              authorization). Default: "false".

            * **insecureIngest** *(boolean) --*

              Whether the channel allows insecure RTMP ingest.
              Default: "false".

            * **latencyMode** *(string) --*

              Channel latency mode. Use "NORMAL" to broadcast and
              deliver live video up to Full HD. Use "LOW" for near-
              real-time interaction with viewers. Default: "LOW".

            * **name** *(string) --*

              Channel name.

            * **playbackRestrictionPolicyArn** *(string) --*

              Playback-restriction-policy ARN. A valid ARN value here
              both specifies the ARN and enables playback restriction.
              Default: "" (empty string, no playback restriction
              policy is applied).

            * **preset** *(string) --*

              Optional transcode preset for the channel. This is
              selectable only for "ADVANCED_HD" and "ADVANCED_SD"
              channel types. For those channel types, the default
              "preset" is "HIGHER_BANDWIDTH_DELIVERY". For other
              channel types ( "BASIC" and "STANDARD"), "preset" is the
              empty string ( """").

            * **recordingConfigurationArn** *(string) --*

              Recording-configuration ARN. A valid ARN value here both
              specifies the ARN and enables recording. Default: ""
              (empty string, recording is disabled).

            * **tags** *(dict) --*

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

              * *(string) --*

                * *(string) --*

            * **type** *(string) --*

              Channel type, which determines the allowable resolution
              and bitrate. *If you exceed the allowable input
              resolution or bitrate, the stream probably will
              disconnect immediately.* Default: "STANDARD". For
              details, see Channel Types.

        * **nextToken** *(string) --*

          If there are more channels than "maxResults", use
          "nextToken" in the request to get the next set.

   **Exceptions**

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.ConflictException"
IVS / Client / delete_playback_key_pair


delete_playback_key_pair
************************

IVS.Client.delete_playback_key_pair(**kwargs)

   Deletes a specified authorization key pair. This invalidates future
   viewer tokens generated using the key pair’s "privateKey". For more
   information, see Setting Up Private Channels in the *Amazon IVS
   User Guide*.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_playback_key_pair(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN of the key pair to be deleted.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"
IVS / Client / can_paginate


can_paginate
************

IVS.Client.can_paginate(operation_name)

   Check if an operation can be paginated.

   Parameters:
      **operation_name** (*string*) -- The operation name.  This is
      the same name as the method name on the client.  For example, if
      the method name is "create_foo", and you'd normally invoke the
      operation as "client.create_foo(**kwargs)", if the "create_foo"
      operation can be paginated, you can use the call
      "client.get_paginator("create_foo")".

   Returns:
      "True" if the operation can be paginated, "False" otherwise.
IVS / Client / list_stream_sessions


list_stream_sessions
********************

IVS.Client.list_stream_sessions(**kwargs)

   Gets a summary of current and previous streams for a specified
   channel in your account, in the AWS region where the API request is
   processed.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_stream_sessions(
          channelArn='string',
          maxResults=123,
          nextToken='string'
      )

   Parameters:
      * **channelArn** (*string*) --

        **[REQUIRED]**

        Channel ARN used to filter the list.

      * **maxResults** (*integer*) -- Maximum number of streams to
        return. Default: 100.

      * **nextToken** (*string*) -- The first stream to retrieve. This
        is used for pagination; see the "nextToken" response field.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'nextToken': 'string',
             'streamSessions': [
                 {
                     'endTime': datetime(2015, 1, 1),
                     'hasErrorEvent': True|False,
                     'startTime': datetime(2015, 1, 1),
                     'streamId': 'string'
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **nextToken** *(string) --*

          If there are more streams than "maxResults", use "nextToken"
          in the request to get the next set.

        * **streamSessions** *(list) --*

          List of stream sessions.

          * *(dict) --*

            Summary information about a stream session.

            * **endTime** *(datetime) --*

              Time when the channel went offline. This is an ISO 8601
              timestamp; *note that this is returned as a string*. For
              live streams, this is "NULL".

            * **hasErrorEvent** *(boolean) --*

              If "true", this stream encountered a quota breach or
              failure.

            * **startTime** *(datetime) --*

              Time when the channel went live. This is an ISO 8601
              timestamp; *note that this is returned as a string*.

            * **streamId** *(string) --*

              Unique identifier for a live or previously live stream
              in the specified channel.

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / delete_recording_configuration


delete_recording_configuration
******************************

IVS.Client.delete_recording_configuration(**kwargs)

   Deletes the recording configuration for the specified ARN.

   If you try to delete a recording configuration that is associated
   with a channel, you will get an error (409 ConflictException). To
   avoid this, for all channels that reference the recording
   configuration, first use  UpdateChannel to set the
   "recordingConfigurationArn" field to an empty string, then use
   DeleteRecordingConfiguration.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_recording_configuration(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN of the recording configuration to be deleted.

   Returns:
      None

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.InternalServerException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.ConflictException"
IVS / Client / list_recording_configurations


list_recording_configurations
*****************************

IVS.Client.list_recording_configurations(**kwargs)

   Gets summary information about all recording configurations in your
   account, in the Amazon Web Services region where the API request is
   processed.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_recording_configurations(
          maxResults=123,
          nextToken='string'
      )

   Parameters:
      * **maxResults** (*integer*) -- Maximum number of recording
        configurations to return. Default: your service quota or 100,
        whichever is smaller.

      * **nextToken** (*string*) -- The first recording configuration
        to retrieve. This is used for pagination; see the "nextToken"
        response field.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'nextToken': 'string',
             'recordingConfigurations': [
                 {
                     'arn': 'string',
                     'destinationConfiguration': {
                         's3': {
                             'bucketName': 'string'
                         }
                     },
                     'name': 'string',
                     'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
                     'tags': {
                         'string': 'string'
                     }
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **nextToken** *(string) --*

          If there are more recording configurations than
          "maxResults", use "nextToken" in the request to get the next
          set.

        * **recordingConfigurations** *(list) --*

          List of the matching recording configurations.

          * *(dict) --*

            Summary information about a RecordingConfiguration.

            * **arn** *(string) --*

              Recording-configuration ARN.

            * **destinationConfiguration** *(dict) --*

              A complex type that contains information about where
              recorded video will be stored.

              * **s3** *(dict) --*

                An S3 destination configuration where recorded videos
                will be stored.

                * **bucketName** *(string) --*

                  Location (S3 bucket name) where recorded videos will
                  be stored.

            * **name** *(string) --*

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

            * **state** *(string) --*

              Indicates the current state of the recording
              configuration. When the state is "ACTIVE", the
              configuration is ready for recording a channel stream.

            * **tags** *(dict) --*

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

              * *(string) --*

                * *(string) --*

   **Exceptions**

   * "IVS.Client.exceptions.InternalServerException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / get_channel


get_channel
***********

IVS.Client.get_channel(**kwargs)

   Gets the channel configuration for the specified channel ARN. See
   also  BatchGetChannel.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_channel(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN of the channel for which the configuration is to be
      retrieved.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'channel': {
                 'arn': 'string',
                 'authorized': True|False,
                 'containerFormat': 'TS'|'FRAGMENTED_MP4',
                 'ingestEndpoint': 'string',
                 'insecureIngest': True|False,
                 'latencyMode': 'NORMAL'|'LOW',
                 'multitrackInputConfiguration': {
                     'enabled': True|False,
                     'maximumResolution': 'SD'|'HD'|'FULL_HD',
                     'policy': 'ALLOW'|'REQUIRE'
                 },
                 'name': 'string',
                 'playbackRestrictionPolicyArn': 'string',
                 'playbackUrl': 'string',
                 'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
                 'recordingConfigurationArn': 'string',
                 'srt': {
                     'endpoint': 'string',
                     'passphrase': 'string'
                 },
                 'tags': {
                     'string': 'string'
                 },
                 'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **channel** *(dict) --*

          * **arn** *(string) --*

            Channel ARN.

          * **authorized** *(boolean) --*

            Whether the channel is private (enabled for playback
            authorization). Default: "false".

          * **containerFormat** *(string) --*

            Indicates which content-packaging format is used (MPEG-TS
            or fMP4). If "multitrackInputConfiguration" is specified
            and "enabled" is "true", then "containerFormat" is
            required and must be set to "FRAGMENTED_MP4". Otherwise,
            "containerFormat" may be set to "TS" or "FRAGMENTED_MP4".
            Default: "TS".

          * **ingestEndpoint** *(string) --*

            Channel ingest endpoint, part of the definition of an
            ingest server, used when you set up streaming software.

          * **insecureIngest** *(boolean) --*

            Whether the channel allows insecure RTMP ingest. Default:
            "false".

          * **latencyMode** *(string) --*

            Channel latency mode. Use "NORMAL" to broadcast and
            deliver live video up to Full HD. Use "LOW" for near-real-
            time interaction with viewers. Default: "LOW".

          * **multitrackInputConfiguration** *(dict) --*

            Object specifying multitrack input configuration. Default:
            no multitrack input configuration is specified.

            * **enabled** *(boolean) --*

              Indicates whether multitrack input is enabled. Can be
              set to "true" only if channel type is "STANDARD".
              Setting "enabled" to "true" with any other channel type
              will cause an exception. If "true", then "policy",
              "maximumResolution", and "containerFormat" are required,
              and "containerFormat" must be set to "FRAGMENTED_MP4".
              Default: "false".

            * **maximumResolution** *(string) --*

              Maximum resolution for multitrack input. Required if
              "enabled" is "true".

            * **policy** *(string) --*

              Indicates whether multitrack input is allowed or
              required. Required if "enabled" is "true".

          * **name** *(string) --*

            Channel name.

          * **playbackRestrictionPolicyArn** *(string) --*

            Playback-restriction-policy ARN. A valid ARN value here
            both specifies the ARN and enables playback restriction.
            Default: "" (empty string, no playback restriction policy
            is applied).

          * **playbackUrl** *(string) --*

            Channel playback URL.

          * **preset** *(string) --*

            Optional transcode preset for the channel. This is
            selectable only for "ADVANCED_HD" and "ADVANCED_SD"
            channel types. For those channel types, the default
            "preset" is "HIGHER_BANDWIDTH_DELIVERY". For other channel
            types ( "BASIC" and "STANDARD"), "preset" is the empty
            string ( """").

          * **recordingConfigurationArn** *(string) --*

            Recording-configuration ARN. A valid ARN value here both
            specifies the ARN and enables recording. Default: ""
            (empty string, recording is disabled).

          * **srt** *(dict) --*

            Specifies the endpoint and optional passphrase for
            streaming with the SRT protocol.

            * **endpoint** *(string) --*

              The endpoint to be used when streaming with IVS using
              the SRT protocol.

            * **passphrase** *(string) --*

              Auto-generated passphrase to enable encryption. This
              field is applicable only if the end user has *not*
              enabled the "insecureIngest" option for the channel.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

          * **type** *(string) --*

            Channel type, which determines the allowable resolution
            and bitrate. *If you exceed the allowable input resolution
            or bitrate, the stream probably will disconnect
            immediately.* Default: "STANDARD". For details, see
            Channel Types.

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / list_tags_for_resource


list_tags_for_resource
**********************

IVS.Client.list_tags_for_resource(**kwargs)

   Gets information about Amazon Web Services tags for the specified
   ARN.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_tags_for_resource(
          resourceArn='string'
      )

   Parameters:
      **resourceArn** (*string*) --

      **[REQUIRED]**

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

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'tags': {
                 'string': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **tags** *(dict) --*

          Tags attached to the resource. Array of maps, each of the
          form "string:string (key:value)".

          * *(string) --*

            * *(string) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.InternalServerException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / batch_get_channel


batch_get_channel
*****************

IVS.Client.batch_get_channel(**kwargs)

   Performs  GetChannel on multiple ARNs simultaneously.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.batch_get_channel(
          arns=[
              'string',
          ]
      )

   Parameters:
      **arns** (*list*) --

      **[REQUIRED]**

      Array of ARNs, one per channel.

      * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'channels': [
                 {
                     'arn': 'string',
                     'authorized': True|False,
                     'containerFormat': 'TS'|'FRAGMENTED_MP4',
                     'ingestEndpoint': 'string',
                     'insecureIngest': True|False,
                     'latencyMode': 'NORMAL'|'LOW',
                     'multitrackInputConfiguration': {
                         'enabled': True|False,
                         'maximumResolution': 'SD'|'HD'|'FULL_HD',
                         'policy': 'ALLOW'|'REQUIRE'
                     },
                     'name': 'string',
                     'playbackRestrictionPolicyArn': 'string',
                     'playbackUrl': 'string',
                     'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
                     'recordingConfigurationArn': 'string',
                     'srt': {
                         'endpoint': 'string',
                         'passphrase': 'string'
                     },
                     'tags': {
                         'string': 'string'
                     },
                     'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
                 },
             ],
             'errors': [
                 {
                     'arn': 'string',
                     'code': 'string',
                     'message': 'string'
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **channels** *(list) --*

          * *(dict) --*

            Object specifying a channel.

            * **arn** *(string) --*

              Channel ARN.

            * **authorized** *(boolean) --*

              Whether the channel is private (enabled for playback
              authorization). Default: "false".

            * **containerFormat** *(string) --*

              Indicates which content-packaging format is used (MPEG-
              TS or fMP4). If "multitrackInputConfiguration" is
              specified and "enabled" is "true", then
              "containerFormat" is required and must be set to
              "FRAGMENTED_MP4". Otherwise, "containerFormat" may be
              set to "TS" or "FRAGMENTED_MP4". Default: "TS".

            * **ingestEndpoint** *(string) --*

              Channel ingest endpoint, part of the definition of an
              ingest server, used when you set up streaming software.

            * **insecureIngest** *(boolean) --*

              Whether the channel allows insecure RTMP ingest.
              Default: "false".

            * **latencyMode** *(string) --*

              Channel latency mode. Use "NORMAL" to broadcast and
              deliver live video up to Full HD. Use "LOW" for near-
              real-time interaction with viewers. Default: "LOW".

            * **multitrackInputConfiguration** *(dict) --*

              Object specifying multitrack input configuration.
              Default: no multitrack input configuration is specified.

              * **enabled** *(boolean) --*

                Indicates whether multitrack input is enabled. Can be
                set to "true" only if channel type is "STANDARD".
                Setting "enabled" to "true" with any other channel
                type will cause an exception. If "true", then
                "policy", "maximumResolution", and "containerFormat"
                are required, and "containerFormat" must be set to
                "FRAGMENTED_MP4". Default: "false".

              * **maximumResolution** *(string) --*

                Maximum resolution for multitrack input. Required if
                "enabled" is "true".

              * **policy** *(string) --*

                Indicates whether multitrack input is allowed or
                required. Required if "enabled" is "true".

            * **name** *(string) --*

              Channel name.

            * **playbackRestrictionPolicyArn** *(string) --*

              Playback-restriction-policy ARN. A valid ARN value here
              both specifies the ARN and enables playback restriction.
              Default: "" (empty string, no playback restriction
              policy is applied).

            * **playbackUrl** *(string) --*

              Channel playback URL.

            * **preset** *(string) --*

              Optional transcode preset for the channel. This is
              selectable only for "ADVANCED_HD" and "ADVANCED_SD"
              channel types. For those channel types, the default
              "preset" is "HIGHER_BANDWIDTH_DELIVERY". For other
              channel types ( "BASIC" and "STANDARD"), "preset" is the
              empty string ( """").

            * **recordingConfigurationArn** *(string) --*

              Recording-configuration ARN. A valid ARN value here both
              specifies the ARN and enables recording. Default: ""
              (empty string, recording is disabled).

            * **srt** *(dict) --*

              Specifies the endpoint and optional passphrase for
              streaming with the SRT protocol.

              * **endpoint** *(string) --*

                The endpoint to be used when streaming with IVS using
                the SRT protocol.

              * **passphrase** *(string) --*

                Auto-generated passphrase to enable encryption. This
                field is applicable only if the end user has *not*
                enabled the "insecureIngest" option for the channel.

            * **tags** *(dict) --*

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

              * *(string) --*

                * *(string) --*

            * **type** *(string) --*

              Channel type, which determines the allowable resolution
              and bitrate. *If you exceed the allowable input
              resolution or bitrate, the stream probably will
              disconnect immediately.* Default: "STANDARD". For
              details, see Channel Types.

        * **errors** *(list) --*

          Each error object is related to a specific ARN in the
          request.

          * *(dict) --*

            Error related to a specific channel, specified by its ARN.

            * **arn** *(string) --*

              ARN of an IVS resource; e.g., channel.

            * **code** *(string) --*

              Error code.

            * **message** *(string) --*

              Error message, determined by the application.
IVS / Client / update_playback_restriction_policy


update_playback_restriction_policy
**********************************

IVS.Client.update_playback_restriction_policy(**kwargs)

   Updates a specified playback restriction policy.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_playback_restriction_policy(
          allowedCountries=[
              'string',
          ],
          allowedOrigins=[
              'string',
          ],
          arn='string',
          enableStrictOriginEnforcement=True|False,
          name='string'
      )

   Parameters:
      * **allowedCountries** (*list*) --

        A list of country codes that control geoblocking restriction.
        Allowed values are the officially assigned ISO 3166-1 alpha-2
        codes. Default: All countries (an empty array).

        * *(string) --*

      * **allowedOrigins** (*list*) --

        A list of origin sites that control CORS restriction. Allowed
        values are the same as valid values of the Origin header
        defined at https://developer.mozilla.org/en-
        US/docs/Web/HTTP/Headers/Origin. Default: All origins (an
        empty array).

        * *(string) --*

      * **arn** (*string*) --

        **[REQUIRED]**

        ARN of the playback-restriction-policy to be updated.

      * **enableStrictOriginEnforcement** (*boolean*) -- Whether
        channel playback is constrained by origin site. Default:
        "false".

      * **name** (*string*) -- Playback-restriction-policy name. The
        value does not need to be unique.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'playbackRestrictionPolicy': {
                 'allowedCountries': [
                     'string',
                 ],
                 'allowedOrigins': [
                     'string',
                 ],
                 'arn': 'string',
                 'enableStrictOriginEnforcement': True|False,
                 'name': 'string',
                 'tags': {
                     'string': 'string'
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **playbackRestrictionPolicy** *(dict) --*

          Object specifying the updated policy.

          * **allowedCountries** *(list) --*

            A list of country codes that control geoblocking
            restriction. Allowed values are the officially assigned
            ISO 3166-1 alpha-2 codes. Default: All countries (an empty
            array).

            * *(string) --*

          * **allowedOrigins** *(list) --*

            A list of origin sites that control CORS restriction.
            Allowed values are the same as valid values of the Origin
            header defined at https://developer.mozilla.org/en-
            US/docs/Web/HTTP/Headers/Origin. Default: All origins (an
            empty array).

            * *(string) --*

          * **arn** *(string) --*

            Playback-restriction-policy ARN

          * **enableStrictOriginEnforcement** *(boolean) --*

            Whether channel playback is constrained by origin site.
            Default: "false".

          * **name** *(string) --*

            Playback-restriction-policy name. The value does not need
            to be unique.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ConflictException"
IVS / Client / untag_resource


untag_resource
**************

IVS.Client.untag_resource(**kwargs)

   Removes tags from the resource with the specified ARN.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.untag_resource(
          resourceArn='string',
          tagKeys=[
              'string',
          ]
      )

   Parameters:
      * **resourceArn** (*string*) --

        **[REQUIRED]**

        ARN of the resource for which tags are to be removed. The ARN
        must be URL-encoded.

      * **tagKeys** (*list*) --

        **[REQUIRED]**

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

        * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.InternalServerException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / get_waiter


get_waiter
**********

IVS.Client.get_waiter(waiter_name)

   Returns an object that can wait for some condition.

   Parameters:
      **waiter_name** (*str*) -- The name of the waiter to get. See
      the waiters section of the service docs for a list of available
      waiters.

   Returns:
      The specified waiter object.

   Return type:
      "botocore.waiter.Waiter"
IVS / Client / stop_stream


stop_stream
***********

IVS.Client.stop_stream(**kwargs)

   Disconnects the incoming RTMPS stream for the specified channel.
   Can be used in conjunction with  DeleteStreamKey to prevent further
   streaming to a channel.

   Note:

     Many streaming client-software libraries automatically reconnect
     a dropped RTMPS session, so to stop the stream permanently, you
     may want to first revoke the "streamKey" attached to the channel.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.stop_stream(
          channelArn='string'
      )

   Parameters:
      **channelArn** (*string*) --

      **[REQUIRED]**

      ARN of the channel for which the stream is to be stopped.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.ChannelNotBroadcasting"

   * "IVS.Client.exceptions.StreamUnavailable"
IVS / Client / list_streams


list_streams
************

IVS.Client.list_streams(**kwargs)

   Gets summary information about live streams in your account, in the
   Amazon Web Services region where the API request is processed.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_streams(
          filterBy={
              'health': 'HEALTHY'|'STARVING'|'UNKNOWN'
          },
          maxResults=123,
          nextToken='string'
      )

   Parameters:
      * **filterBy** (*dict*) --

        Filters the stream list to match the specified criterion.

        * **health** *(string) --*

          The stream’s health.

      * **maxResults** (*integer*) -- Maximum number of streams to
        return. Default: 100.

      * **nextToken** (*string*) -- The first stream to retrieve. This
        is used for pagination; see the "nextToken" response field.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'nextToken': 'string',
             'streams': [
                 {
                     'channelArn': 'string',
                     'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
                     'startTime': datetime(2015, 1, 1),
                     'state': 'LIVE'|'OFFLINE',
                     'streamId': 'string',
                     'viewerCount': 123
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **nextToken** *(string) --*

          If there are more streams than "maxResults", use "nextToken"
          in the request to get the next set.

        * **streams** *(list) --*

          List of streams.

          * *(dict) --*

            Summary information about a stream.

            * **channelArn** *(string) --*

              Channel ARN for the stream.

            * **health** *(string) --*

              The stream’s health.

            * **startTime** *(datetime) --*

              Time of the stream’s start. This is an ISO 8601
              timestamp; *note that this is returned as a string*.

            * **state** *(string) --*

              The stream’s state. Do not rely on the "OFFLINE" state,
              as the API may not return it; instead, a
              "NotBroadcasting" error will indicate that the stream is
              not live.

            * **streamId** *(string) --*

              Unique identifier for a live or previously live stream
              in the specified channel.

            * **viewerCount** *(integer) --*

              A count of concurrent views of the stream. Typically, a
              new view appears in "viewerCount" within 15 seconds of
              when video playback starts and a view is removed from
              "viewerCount" within 1 minute of when video playback
              ends. A value of -1 indicates that the request timed
              out; in this case, retry.

   **Exceptions**

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / create_channel


create_channel
**************

IVS.Client.create_channel(**kwargs)

   Creates a new channel and an associated stream key to start
   streaming.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_channel(
          authorized=True|False,
          containerFormat='TS'|'FRAGMENTED_MP4',
          insecureIngest=True|False,
          latencyMode='NORMAL'|'LOW',
          multitrackInputConfiguration={
              'enabled': True|False,
              'maximumResolution': 'SD'|'HD'|'FULL_HD',
              'policy': 'ALLOW'|'REQUIRE'
          },
          name='string',
          playbackRestrictionPolicyArn='string',
          preset='HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
          recordingConfigurationArn='string',
          tags={
              'string': 'string'
          },
          type='BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
      )

   Parameters:
      * **authorized** (*boolean*) -- Whether the channel is private
        (enabled for playback authorization). Default: "false".

      * **containerFormat** (*string*) -- Indicates which content-
        packaging format is used (MPEG-TS or fMP4). If
        "multitrackInputConfiguration" is specified and "enabled" is
        "true", then "containerFormat" is required and must be set to
        "FRAGMENTED_MP4". Otherwise, "containerFormat" may be set to
        "TS" or "FRAGMENTED_MP4". Default: "TS".

      * **insecureIngest** (*boolean*) -- Whether the channel allows
        insecure RTMP and SRT ingest. Default: "false".

      * **latencyMode** (*string*) -- Channel latency mode. Use
        "NORMAL" to broadcast and deliver live video up to Full HD.
        Use "LOW" for near-real-time interaction with viewers.
        Default: "LOW".

      * **multitrackInputConfiguration** (*dict*) --

        Object specifying multitrack input configuration. Default: no
        multitrack input configuration is specified.

        * **enabled** *(boolean) --*

          Indicates whether multitrack input is enabled. Can be set to
          "true" only if channel type is "STANDARD". Setting "enabled"
          to "true" with any other channel type will cause an
          exception. If "true", then "policy", "maximumResolution",
          and "containerFormat" are required, and "containerFormat"
          must be set to "FRAGMENTED_MP4". Default: "false".

        * **maximumResolution** *(string) --*

          Maximum resolution for multitrack input. Required if
          "enabled" is "true".

        * **policy** *(string) --*

          Indicates whether multitrack input is allowed or required.
          Required if "enabled" is "true".

      * **name** (*string*) -- Channel name.

      * **playbackRestrictionPolicyArn** (*string*) -- Playback-
        restriction-policy ARN. A valid ARN value here both specifies
        the ARN and enables playback restriction. Default: "" (empty
        string, no playback restriction policy is applied).

      * **preset** (*string*) -- Optional transcode preset for the
        channel. This is selectable only for "ADVANCED_HD" and
        "ADVANCED_SD" channel types. For those channel types, the
        default "preset" is "HIGHER_BANDWIDTH_DELIVERY". For other
        channel types ( "BASIC" and "STANDARD"), "preset" is the empty
        string ( """").

      * **recordingConfigurationArn** (*string*) -- Recording-
        configuration ARN. A valid ARN value here both specifies the
        ARN and enables recording. Default: "" (empty string,
        recording is disabled).

      * **tags** (*dict*) --

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

        * *(string) --*

          * *(string) --*

      * **type** (*string*) -- Channel type, which determines the
        allowable resolution and bitrate. *If you exceed the allowable
        input resolution or bitrate, the stream probably will
        disconnect immediately.* Default: "STANDARD". For details, see
        Channel Types.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'channel': {
                 'arn': 'string',
                 'authorized': True|False,
                 'containerFormat': 'TS'|'FRAGMENTED_MP4',
                 'ingestEndpoint': 'string',
                 'insecureIngest': True|False,
                 'latencyMode': 'NORMAL'|'LOW',
                 'multitrackInputConfiguration': {
                     'enabled': True|False,
                     'maximumResolution': 'SD'|'HD'|'FULL_HD',
                     'policy': 'ALLOW'|'REQUIRE'
                 },
                 'name': 'string',
                 'playbackRestrictionPolicyArn': 'string',
                 'playbackUrl': 'string',
                 'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
                 'recordingConfigurationArn': 'string',
                 'srt': {
                     'endpoint': 'string',
                     'passphrase': 'string'
                 },
                 'tags': {
                     'string': 'string'
                 },
                 'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
             },
             'streamKey': {
                 'arn': 'string',
                 'channelArn': 'string',
                 'tags': {
                     'string': 'string'
                 },
                 'value': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **channel** *(dict) --*

          * **arn** *(string) --*

            Channel ARN.

          * **authorized** *(boolean) --*

            Whether the channel is private (enabled for playback
            authorization). Default: "false".

          * **containerFormat** *(string) --*

            Indicates which content-packaging format is used (MPEG-TS
            or fMP4). If "multitrackInputConfiguration" is specified
            and "enabled" is "true", then "containerFormat" is
            required and must be set to "FRAGMENTED_MP4". Otherwise,
            "containerFormat" may be set to "TS" or "FRAGMENTED_MP4".
            Default: "TS".

          * **ingestEndpoint** *(string) --*

            Channel ingest endpoint, part of the definition of an
            ingest server, used when you set up streaming software.

          * **insecureIngest** *(boolean) --*

            Whether the channel allows insecure RTMP ingest. Default:
            "false".

          * **latencyMode** *(string) --*

            Channel latency mode. Use "NORMAL" to broadcast and
            deliver live video up to Full HD. Use "LOW" for near-real-
            time interaction with viewers. Default: "LOW".

          * **multitrackInputConfiguration** *(dict) --*

            Object specifying multitrack input configuration. Default:
            no multitrack input configuration is specified.

            * **enabled** *(boolean) --*

              Indicates whether multitrack input is enabled. Can be
              set to "true" only if channel type is "STANDARD".
              Setting "enabled" to "true" with any other channel type
              will cause an exception. If "true", then "policy",
              "maximumResolution", and "containerFormat" are required,
              and "containerFormat" must be set to "FRAGMENTED_MP4".
              Default: "false".

            * **maximumResolution** *(string) --*

              Maximum resolution for multitrack input. Required if
              "enabled" is "true".

            * **policy** *(string) --*

              Indicates whether multitrack input is allowed or
              required. Required if "enabled" is "true".

          * **name** *(string) --*

            Channel name.

          * **playbackRestrictionPolicyArn** *(string) --*

            Playback-restriction-policy ARN. A valid ARN value here
            both specifies the ARN and enables playback restriction.
            Default: "" (empty string, no playback restriction policy
            is applied).

          * **playbackUrl** *(string) --*

            Channel playback URL.

          * **preset** *(string) --*

            Optional transcode preset for the channel. This is
            selectable only for "ADVANCED_HD" and "ADVANCED_SD"
            channel types. For those channel types, the default
            "preset" is "HIGHER_BANDWIDTH_DELIVERY". For other channel
            types ( "BASIC" and "STANDARD"), "preset" is the empty
            string ( """").

          * **recordingConfigurationArn** *(string) --*

            Recording-configuration ARN. A valid ARN value here both
            specifies the ARN and enables recording. Default: ""
            (empty string, recording is disabled).

          * **srt** *(dict) --*

            Specifies the endpoint and optional passphrase for
            streaming with the SRT protocol.

            * **endpoint** *(string) --*

              The endpoint to be used when streaming with IVS using
              the SRT protocol.

            * **passphrase** *(string) --*

              Auto-generated passphrase to enable encryption. This
              field is applicable only if the end user has *not*
              enabled the "insecureIngest" option for the channel.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

          * **type** *(string) --*

            Channel type, which determines the allowable resolution
            and bitrate. *If you exceed the allowable input resolution
            or bitrate, the stream probably will disconnect
            immediately.* Default: "STANDARD". For details, see
            Channel Types.

        * **streamKey** *(dict) --*

          * **arn** *(string) --*

            Stream-key ARN.

          * **channelArn** *(string) --*

            Channel ARN for the stream.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

          * **value** *(string) --*

            Stream-key value.

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ServiceQuotaExceededException"
IVS / Client / put_metadata


put_metadata
************

IVS.Client.put_metadata(**kwargs)

   Inserts metadata into the active stream of the specified channel.
   At most 5 requests per second per channel are allowed, each with a
   maximum 1 KB payload. (If 5 TPS is not sufficient for your needs,
   we recommend batching your data into a single PutMetadata call.) At
   most 155 requests per second per account are allowed. Also see
   Embedding Metadata within a Video Stream in the *Amazon IVS User
   Guide*.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.put_metadata(
          channelArn='string',
          metadata='string'
      )

   Parameters:
      * **channelArn** (*string*) --

        **[REQUIRED]**

        ARN of the channel into which metadata is inserted. This
        channel must have an active stream.

      * **metadata** (*string*) --

        **[REQUIRED]**

        Metadata to insert into the stream. Maximum: 1 KB per request.

   Returns:
      None

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.ChannelNotBroadcasting"

   * "IVS.Client.exceptions.ThrottlingException"
IVS / Client / delete_playback_restriction_policy


delete_playback_restriction_policy
**********************************

IVS.Client.delete_playback_restriction_policy(**kwargs)

   Deletes the specified playback restriction policy.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_playback_restriction_policy(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN of the playback restriction policy to be deleted.

   Returns:
      None

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ConflictException"
IVS / Client / get_stream


get_stream
**********

IVS.Client.get_stream(**kwargs)

   Gets information about the active (live) stream on a specified
   channel.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_stream(
          channelArn='string'
      )

   Parameters:
      **channelArn** (*string*) --

      **[REQUIRED]**

      Channel ARN for stream to be accessed.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'stream': {
                 'channelArn': 'string',
                 'health': 'HEALTHY'|'STARVING'|'UNKNOWN',
                 'playbackUrl': 'string',
                 'startTime': datetime(2015, 1, 1),
                 'state': 'LIVE'|'OFFLINE',
                 'streamId': 'string',
                 'viewerCount': 123
             }
         }

      **Response Structure**

      * *(dict) --*

        * **stream** *(dict) --*

          * **channelArn** *(string) --*

            Channel ARN for the stream.

          * **health** *(string) --*

            The stream’s health.

          * **playbackUrl** *(string) --*

            URL of the master playlist, required by the video player
            to play the HLS stream.

          * **startTime** *(datetime) --*

            Time of the stream’s start. This is an ISO 8601 timestamp;
            *note that this is returned as a string*.

          * **state** *(string) --*

            The stream’s state. Do not rely on the "OFFLINE" state, as
            the API may not return it; instead, a "NotBroadcasting"
            error will indicate that the stream is not live.

          * **streamId** *(string) --*

            Unique identifier for a live or previously live stream in
            the specified channel.

          * **viewerCount** *(integer) --*

            A count of concurrent views of the stream. Typically, a
            new view appears in "viewerCount" within 15 seconds of
            when video playback starts and a view is removed from
            "viewerCount" within 1 minute of when video playback ends.
            A value of -1 indicates that the request timed out; in
            this case, retry.

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.ChannelNotBroadcasting"
IVS / Client / delete_channel


delete_channel
**************

IVS.Client.delete_channel(**kwargs)

   Deletes the specified channel and its associated stream keys.

   If you try to delete a live channel, you will get an error (409
   ConflictException). To delete a channel that is live, call
   StopStream, wait for the Amazon EventBridge "Stream End" event (to
   verify that the stream's state is no longer Live), then call
   DeleteChannel. (See Using EventBridge with Amazon IVS.)

   See also: AWS API Documentation

   **Request Syntax**

      response = client.delete_channel(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN of the channel to be deleted.

   Returns:
      None

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ConflictException"
IVS / Client / create_recording_configuration


create_recording_configuration
******************************

IVS.Client.create_recording_configuration(**kwargs)

   Creates a new recording configuration, used to enable recording to
   Amazon S3.

   **Known issue:** In the us-east-1 region, if you use the Amazon Web
   Services CLI to create a recording configuration, it returns
   success even if the S3 bucket is in a different region. In this
   case, the "state" of the recording configuration is "CREATE_FAILED"
   (instead of "ACTIVE"). (In other regions, the CLI correctly returns
   failure if the bucket is in a different region.)

   **Workaround:** Ensure that your S3 bucket is in the same region as
   the recording configuration. If you create a recording
   configuration in a different region as your S3 bucket, delete that
   recording configuration and create a new one with an S3 bucket from
   the correct region.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_recording_configuration(
          destinationConfiguration={
              's3': {
                  'bucketName': 'string'
              }
          },
          name='string',
          recordingReconnectWindowSeconds=123,
          renditionConfiguration={
              'renditionSelection': 'ALL'|'NONE'|'CUSTOM',
              'renditions': [
                  'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
              ]
          },
          tags={
              'string': 'string'
          },
          thumbnailConfiguration={
              'recordingMode': 'DISABLED'|'INTERVAL',
              'resolution': 'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
              'storage': [
                  'SEQUENTIAL'|'LATEST',
              ],
              'targetIntervalSeconds': 123
          }
      )

   Parameters:
      * **destinationConfiguration** (*dict*) --

        **[REQUIRED]**

        A complex type that contains a destination configuration for
        where recorded video will be stored.

        * **s3** *(dict) --*

          An S3 destination configuration where recorded videos will
          be stored.

          * **bucketName** *(string) --* **[REQUIRED]**

            Location (S3 bucket name) where recorded videos will be
            stored.

      * **name** (*string*) -- Recording-configuration name. The value
        does not need to be unique.

      * **recordingReconnectWindowSeconds** (*integer*) -- If a
        broadcast disconnects and then reconnects within the specified
        interval, the multiple streams will be considered a single
        broadcast and merged together. Default: 0.

      * **renditionConfiguration** (*dict*) --

        Object that describes which renditions should be recorded for
        a stream.

        * **renditionSelection** *(string) --*

          Indicates which set of renditions are recorded for a stream.
          For "BASIC" channels, the "CUSTOM" value has no effect. If
          "CUSTOM" is specified, a set of renditions must be specified
          in the "renditions" field. Default: "ALL".

        * **renditions** *(list) --*

          Indicates which renditions are recorded for a stream, if
          "renditionSelection" is "CUSTOM"; otherwise, this field is
          irrelevant. The selected renditions are recorded if they are
          available during the stream. If a selected rendition is
          unavailable, the best available rendition is recorded. For
          details on the resolution dimensions of each rendition, see
          Auto-Record to Amazon S3.

          * *(string) --*

      * **tags** (*dict*) --

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

        * *(string) --*

          * *(string) --*

      * **thumbnailConfiguration** (*dict*) --

        A complex type that allows you to enable/disable the recording
        of thumbnails for a live session and modify the interval at
        which thumbnails are generated for the live session.

        * **recordingMode** *(string) --*

          Thumbnail recording mode. Default: "INTERVAL".

        * **resolution** *(string) --*

          Indicates the desired resolution of recorded thumbnails.
          Thumbnails are recorded at the selected resolution if the
          corresponding rendition is available during the stream;
          otherwise, they are recorded at source resolution. For more
          information about resolution values and their corresponding
          height and width dimensions, see Auto-Record to Amazon S3.
          Default: Null (source resolution is returned).

        * **storage** *(list) --*

          Indicates the format in which thumbnails are recorded.
          "SEQUENTIAL" records all generated thumbnails in a serial
          manner, to the media/thumbnails directory. "LATEST" saves
          the latest thumbnail in media/latest_thumbnail/thumb.jpg and
          overwrites it at the interval specified by
          "targetIntervalSeconds". You can enable both "SEQUENTIAL"
          and "LATEST". Default: "SEQUENTIAL".

          * *(string) --*

        * **targetIntervalSeconds** *(integer) --*

          The targeted thumbnail-generation interval in seconds. This
          is configurable (and required) only if "recordingMode" is
          "INTERVAL". Default: 60.

          **Important:** For the "BASIC" channel type, or the
          "STANDARD" channel type with multitrack input, setting a
          value for "targetIntervalSeconds" does not guarantee that
          thumbnails are generated at the specified interval. For
          thumbnails to be generated at the "targetIntervalSeconds"
          interval, the "IDR/Keyframe" value for the input video must
          be less than the "targetIntervalSeconds" value. See Amazon
          IVS Streaming Configuration for information on setting
          "IDR/Keyframe" to the recommended value in video-encoder
          settings.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'recordingConfiguration': {
                 'arn': 'string',
                 'destinationConfiguration': {
                     's3': {
                         'bucketName': 'string'
                     }
                 },
                 'name': 'string',
                 'recordingReconnectWindowSeconds': 123,
                 'renditionConfiguration': {
                     'renditionSelection': 'ALL'|'NONE'|'CUSTOM',
                     'renditions': [
                         'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
                     ]
                 },
                 'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
                 'tags': {
                     'string': 'string'
                 },
                 'thumbnailConfiguration': {
                     'recordingMode': 'DISABLED'|'INTERVAL',
                     'resolution': 'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
                     'storage': [
                         'SEQUENTIAL'|'LATEST',
                     ],
                     'targetIntervalSeconds': 123
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **recordingConfiguration** *(dict) --*

          * **arn** *(string) --*

            Recording-configuration ARN.

          * **destinationConfiguration** *(dict) --*

            A complex type that contains information about where
            recorded video will be stored.

            * **s3** *(dict) --*

              An S3 destination configuration where recorded videos
              will be stored.

              * **bucketName** *(string) --*

                Location (S3 bucket name) where recorded videos will
                be stored.

          * **name** *(string) --*

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

          * **recordingReconnectWindowSeconds** *(integer) --*

            If a broadcast disconnects and then reconnects within the
            specified interval, the multiple streams will be
            considered a single broadcast and merged together.
            Default: 0.

          * **renditionConfiguration** *(dict) --*

            Object that describes which renditions should be recorded
            for a stream.

            * **renditionSelection** *(string) --*

              Indicates which set of renditions are recorded for a
              stream. For "BASIC" channels, the "CUSTOM" value has no
              effect. If "CUSTOM" is specified, a set of renditions
              must be specified in the "renditions" field. Default:
              "ALL".

            * **renditions** *(list) --*

              Indicates which renditions are recorded for a stream, if
              "renditionSelection" is "CUSTOM"; otherwise, this field
              is irrelevant. The selected renditions are recorded if
              they are available during the stream. If a selected
              rendition is unavailable, the best available rendition
              is recorded. For details on the resolution dimensions of
              each rendition, see Auto-Record to Amazon S3.

              * *(string) --*

          * **state** *(string) --*

            Indicates the current state of the recording
            configuration. When the state is "ACTIVE", the
            configuration is ready for recording a channel stream.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

          * **thumbnailConfiguration** *(dict) --*

            A complex type that allows you to enable/disable the
            recording of thumbnails for a live session and modify the
            interval at which thumbnails are generated for the live
            session.

            * **recordingMode** *(string) --*

              Thumbnail recording mode. Default: "INTERVAL".

            * **resolution** *(string) --*

              Indicates the desired resolution of recorded thumbnails.
              Thumbnails are recorded at the selected resolution if
              the corresponding rendition is available during the
              stream; otherwise, they are recorded at source
              resolution. For more information about resolution values
              and their corresponding height and width dimensions, see
              Auto-Record to Amazon S3. Default: Null (source
              resolution is returned).

            * **storage** *(list) --*

              Indicates the format in which thumbnails are recorded.
              "SEQUENTIAL" records all generated thumbnails in a
              serial manner, to the media/thumbnails directory.
              "LATEST" saves the latest thumbnail in
              media/latest_thumbnail/thumb.jpg and overwrites it at
              the interval specified by "targetIntervalSeconds". You
              can enable both "SEQUENTIAL" and "LATEST". Default:
              "SEQUENTIAL".

              * *(string) --*

            * **targetIntervalSeconds** *(integer) --*

              The targeted thumbnail-generation interval in seconds.
              This is configurable (and required) only if
              "recordingMode" is "INTERVAL". Default: 60.

              **Important:** For the "BASIC" channel type, or the
              "STANDARD" channel type with multitrack input, setting a
              value for "targetIntervalSeconds" does not guarantee
              that thumbnails are generated at the specified interval.
              For thumbnails to be generated at the
              "targetIntervalSeconds" interval, the "IDR/Keyframe"
              value for the input video must be less than the
              "targetIntervalSeconds" value. See Amazon IVS Streaming
              Configuration for information on setting "IDR/Keyframe"
              to the recommended value in video-encoder settings.

   **Exceptions**

   * "IVS.Client.exceptions.InternalServerException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ConflictException"

   * "IVS.Client.exceptions.ServiceQuotaExceededException"
IVS / Client / list_stream_keys


list_stream_keys
****************

IVS.Client.list_stream_keys(**kwargs)

   Gets summary information about stream keys for the specified
   channel.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_stream_keys(
          channelArn='string',
          maxResults=123,
          nextToken='string'
      )

   Parameters:
      * **channelArn** (*string*) --

        **[REQUIRED]**

        Channel ARN used to filter the list.

      * **maxResults** (*integer*) -- Maximum number of streamKeys to
        return. Default: 1.

      * **nextToken** (*string*) -- The first stream key to retrieve.
        This is used for pagination; see the "nextToken" response
        field.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'nextToken': 'string',
             'streamKeys': [
                 {
                     'arn': 'string',
                     'channelArn': 'string',
                     'tags': {
                         'string': 'string'
                     }
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **nextToken** *(string) --*

          If there are more stream keys than "maxResults", use
          "nextToken" in the request to get the next set.

        * **streamKeys** *(list) --*

          List of stream keys.

          * *(dict) --*

            Summary information about a stream key.

            * **arn** *(string) --*

              Stream-key ARN.

            * **channelArn** *(string) --*

              Channel ARN for the stream.

            * **tags** *(dict) --*

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

              * *(string) --*

                * *(string) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / get_recording_configuration


get_recording_configuration
***************************

IVS.Client.get_recording_configuration(**kwargs)

   Gets the recording configuration for the specified ARN.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_recording_configuration(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN of the recording configuration to be retrieved.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'recordingConfiguration': {
                 'arn': 'string',
                 'destinationConfiguration': {
                     's3': {
                         'bucketName': 'string'
                     }
                 },
                 'name': 'string',
                 'recordingReconnectWindowSeconds': 123,
                 'renditionConfiguration': {
                     'renditionSelection': 'ALL'|'NONE'|'CUSTOM',
                     'renditions': [
                         'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
                     ]
                 },
                 'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
                 'tags': {
                     'string': 'string'
                 },
                 'thumbnailConfiguration': {
                     'recordingMode': 'DISABLED'|'INTERVAL',
                     'resolution': 'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
                     'storage': [
                         'SEQUENTIAL'|'LATEST',
                     ],
                     'targetIntervalSeconds': 123
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **recordingConfiguration** *(dict) --*

          * **arn** *(string) --*

            Recording-configuration ARN.

          * **destinationConfiguration** *(dict) --*

            A complex type that contains information about where
            recorded video will be stored.

            * **s3** *(dict) --*

              An S3 destination configuration where recorded videos
              will be stored.

              * **bucketName** *(string) --*

                Location (S3 bucket name) where recorded videos will
                be stored.

          * **name** *(string) --*

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

          * **recordingReconnectWindowSeconds** *(integer) --*

            If a broadcast disconnects and then reconnects within the
            specified interval, the multiple streams will be
            considered a single broadcast and merged together.
            Default: 0.

          * **renditionConfiguration** *(dict) --*

            Object that describes which renditions should be recorded
            for a stream.

            * **renditionSelection** *(string) --*

              Indicates which set of renditions are recorded for a
              stream. For "BASIC" channels, the "CUSTOM" value has no
              effect. If "CUSTOM" is specified, a set of renditions
              must be specified in the "renditions" field. Default:
              "ALL".

            * **renditions** *(list) --*

              Indicates which renditions are recorded for a stream, if
              "renditionSelection" is "CUSTOM"; otherwise, this field
              is irrelevant. The selected renditions are recorded if
              they are available during the stream. If a selected
              rendition is unavailable, the best available rendition
              is recorded. For details on the resolution dimensions of
              each rendition, see Auto-Record to Amazon S3.

              * *(string) --*

          * **state** *(string) --*

            Indicates the current state of the recording
            configuration. When the state is "ACTIVE", the
            configuration is ready for recording a channel stream.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

          * **thumbnailConfiguration** *(dict) --*

            A complex type that allows you to enable/disable the
            recording of thumbnails for a live session and modify the
            interval at which thumbnails are generated for the live
            session.

            * **recordingMode** *(string) --*

              Thumbnail recording mode. Default: "INTERVAL".

            * **resolution** *(string) --*

              Indicates the desired resolution of recorded thumbnails.
              Thumbnails are recorded at the selected resolution if
              the corresponding rendition is available during the
              stream; otherwise, they are recorded at source
              resolution. For more information about resolution values
              and their corresponding height and width dimensions, see
              Auto-Record to Amazon S3. Default: Null (source
              resolution is returned).

            * **storage** *(list) --*

              Indicates the format in which thumbnails are recorded.
              "SEQUENTIAL" records all generated thumbnails in a
              serial manner, to the media/thumbnails directory.
              "LATEST" saves the latest thumbnail in
              media/latest_thumbnail/thumb.jpg and overwrites it at
              the interval specified by "targetIntervalSeconds". You
              can enable both "SEQUENTIAL" and "LATEST". Default:
              "SEQUENTIAL".

              * *(string) --*

            * **targetIntervalSeconds** *(integer) --*

              The targeted thumbnail-generation interval in seconds.
              This is configurable (and required) only if
              "recordingMode" is "INTERVAL". Default: 60.

              **Important:** For the "BASIC" channel type, or the
              "STANDARD" channel type with multitrack input, setting a
              value for "targetIntervalSeconds" does not guarantee
              that thumbnails are generated at the specified interval.
              For thumbnails to be generated at the
              "targetIntervalSeconds" interval, the "IDR/Keyframe"
              value for the input video must be less than the
              "targetIntervalSeconds" value. See Amazon IVS Streaming
              Configuration for information on setting "IDR/Keyframe"
              to the recommended value in video-encoder settings.

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.InternalServerException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / batch_start_viewer_session_revocation


batch_start_viewer_session_revocation
*************************************

IVS.Client.batch_start_viewer_session_revocation(**kwargs)

   Performs  StartViewerSessionRevocation on multiple channel ARN and
   viewer ID pairs simultaneously.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.batch_start_viewer_session_revocation(
          viewerSessions=[
              {
                  'channelArn': 'string',
                  'viewerId': 'string',
                  'viewerSessionVersionsLessThanOrEqualTo': 123
              },
          ]
      )

   Parameters:
      **viewerSessions** (*list*) --

      **[REQUIRED]**

      Array of viewer sessions, one per channel-ARN and viewer-ID
      pair.

      * *(dict) --*

        A viewer session to revoke in the call to
        BatchStartViewerSessionRevocation.

        * **channelArn** *(string) --* **[REQUIRED]**

          The ARN of the channel associated with the viewer session to
          revoke.

        * **viewerId** *(string) --* **[REQUIRED]**

          The ID of the viewer associated with the viewer session to
          revoke. Do not use this field for personally identifying,
          confidential, or sensitive information.

        * **viewerSessionVersionsLessThanOrEqualTo** *(integer) --*

          An optional filter on which versions of the viewer session
          to revoke. All versions less than or equal to the specified
          version will be revoked. Default: 0.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'errors': [
                 {
                     'channelArn': 'string',
                     'code': 'string',
                     'message': 'string',
                     'viewerId': 'string'
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **errors** *(list) --*

          Each error object is related to a specific "channelArn" and
          "viewerId" pair in the request.

          * *(dict) --*

            Error for a request in the batch for
            BatchStartViewerSessionRevocation. Each error is related
            to a specific channel-ARN and viewer-ID pair.

            * **channelArn** *(string) --*

              Channel ARN.

            * **code** *(string) --*

              Error code.

            * **message** *(string) --*

              Error message, determined by the application.

            * **viewerId** *(string) --*

              The ID of the viewer session to revoke.

   **Exceptions**

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ThrottlingException"
IVS / Client / get_stream_key


get_stream_key
**************

IVS.Client.get_stream_key(**kwargs)

   Gets stream-key information for a specified ARN.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_stream_key(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN for the stream key to be retrieved.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'streamKey': {
                 'arn': 'string',
                 'channelArn': 'string',
                 'tags': {
                     'string': 'string'
                 },
                 'value': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **streamKey** *(dict) --*

          * **arn** *(string) --*

            Stream-key ARN.

          * **channelArn** *(string) --*

            Channel ARN for the stream.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

          * **value** *(string) --*

            Stream-key value.

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / import_playback_key_pair


import_playback_key_pair
************************

IVS.Client.import_playback_key_pair(**kwargs)

   Imports the public portion of a new key pair and returns its "arn"
   and "fingerprint". The "privateKey" can then be used to generate
   viewer authorization tokens, to grant viewers access to private
   channels. For more information, see Setting Up Private Channels in
   the *Amazon IVS User Guide*.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.import_playback_key_pair(
          name='string',
          publicKeyMaterial='string',
          tags={
              'string': 'string'
          }
      )

   Parameters:
      * **name** (*string*) -- Playback-key-pair name. The value does
        not need to be unique.

      * **publicKeyMaterial** (*string*) --

        **[REQUIRED]**

        The public portion of a customer-generated key pair.

      * **tags** (*dict*) --

        Any tags provided with the request are added to the playback
        key pair tags. See Best practices and strategies in *Tagging
        Amazon Web Services Resources and Tag Editor* for details,
        including restrictions that apply to tags and "Tag naming
        limits and requirements"; Amazon IVS has no service-specific
        constraints beyond what is documented there.

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'keyPair': {
                 'arn': 'string',
                 'fingerprint': 'string',
                 'name': 'string',
                 'tags': {
                     'string': 'string'
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **keyPair** *(dict) --*

          * **arn** *(string) --*

            Key-pair ARN.

          * **fingerprint** *(string) --*

            Key-pair identifier.

          * **name** *(string) --*

            Playback-key-pair name. The value does not need to be
            unique.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

   **Exceptions**

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ConflictException"

   * "IVS.Client.exceptions.ServiceQuotaExceededException"
IVS / Client / close


close
*****

IVS.Client.close()

   Closes underlying endpoint connections.
IVS / Client / create_playback_restriction_policy


create_playback_restriction_policy
**********************************

IVS.Client.create_playback_restriction_policy(**kwargs)

   Creates a new playback restriction policy, for constraining
   playback by countries and/or origins.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_playback_restriction_policy(
          allowedCountries=[
              'string',
          ],
          allowedOrigins=[
              'string',
          ],
          enableStrictOriginEnforcement=True|False,
          name='string',
          tags={
              'string': 'string'
          }
      )

   Parameters:
      * **allowedCountries** (*list*) --

        A list of country codes that control geoblocking restriction.
        Allowed values are the officially assigned ISO 3166-1 alpha-2
        codes. Default: All countries (an empty array).

        * *(string) --*

      * **allowedOrigins** (*list*) --

        A list of origin sites that control CORS restriction. Allowed
        values are the same as valid values of the Origin header
        defined at https://developer.mozilla.org/en-
        US/docs/Web/HTTP/Headers/Origin. Default: All origins (an
        empty array).

        * *(string) --*

      * **enableStrictOriginEnforcement** (*boolean*) -- Whether
        channel playback is constrained by origin site. Default:
        "false".

      * **name** (*string*) -- Playback-restriction-policy name. The
        value does not need to be unique.

      * **tags** (*dict*) --

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

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'playbackRestrictionPolicy': {
                 'allowedCountries': [
                     'string',
                 ],
                 'allowedOrigins': [
                     'string',
                 ],
                 'arn': 'string',
                 'enableStrictOriginEnforcement': True|False,
                 'name': 'string',
                 'tags': {
                     'string': 'string'
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **playbackRestrictionPolicy** *(dict) --*

          * **allowedCountries** *(list) --*

            A list of country codes that control geoblocking
            restriction. Allowed values are the officially assigned
            ISO 3166-1 alpha-2 codes. Default: All countries (an empty
            array).

            * *(string) --*

          * **allowedOrigins** *(list) --*

            A list of origin sites that control CORS restriction.
            Allowed values are the same as valid values of the Origin
            header defined at https://developer.mozilla.org/en-
            US/docs/Web/HTTP/Headers/Origin. Default: All origins (an
            empty array).

            * *(string) --*

          * **arn** *(string) --*

            Playback-restriction-policy ARN

          * **enableStrictOriginEnforcement** *(boolean) --*

            Whether channel playback is constrained by origin site.
            Default: "false".

          * **name** *(string) --*

            Playback-restriction-policy name. The value does not need
            to be unique.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

   **Exceptions**

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ThrottlingException"

   * "IVS.Client.exceptions.ServiceQuotaExceededException"
IVS / Client / list_playback_key_pairs


list_playback_key_pairs
***********************

IVS.Client.list_playback_key_pairs(**kwargs)

   Gets summary information about playback key pairs. For more
   information, see Setting Up Private Channels in the *Amazon IVS
   User Guide*.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_playback_key_pairs(
          maxResults=123,
          nextToken='string'
      )

   Parameters:
      * **maxResults** (*integer*) -- Maximum number of key pairs to
        return. Default: your service quota or 100, whichever is
        smaller.

      * **nextToken** (*string*) -- The first key pair to retrieve.
        This is used for pagination; see the "nextToken" response
        field.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'keyPairs': [
                 {
                     'arn': 'string',
                     'name': 'string',
                     'tags': {
                         'string': 'string'
                     }
                 },
             ],
             'nextToken': 'string'
         }

      **Response Structure**

      * *(dict) --*

        * **keyPairs** *(list) --*

          List of key pairs.

          * *(dict) --*

            Summary information about a playback key pair.

            * **arn** *(string) --*

              Key-pair ARN.

            * **name** *(string) --*

              Playback-key-pair name. The value does not need to be
              unique.

            * **tags** *(dict) --*

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

              * *(string) --*

                * *(string) --*

        * **nextToken** *(string) --*

          If there are more key pairs than "maxResults", use
          "nextToken" in the request to get the next set.

   **Exceptions**

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / batch_get_stream_key


batch_get_stream_key
********************

IVS.Client.batch_get_stream_key(**kwargs)

   Performs  GetStreamKey on multiple ARNs simultaneously.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.batch_get_stream_key(
          arns=[
              'string',
          ]
      )

   Parameters:
      **arns** (*list*) --

      **[REQUIRED]**

      Array of ARNs, one per stream key.

      * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'errors': [
                 {
                     'arn': 'string',
                     'code': 'string',
                     'message': 'string'
                 },
             ],
             'streamKeys': [
                 {
                     'arn': 'string',
                     'channelArn': 'string',
                     'tags': {
                         'string': 'string'
                     },
                     'value': 'string'
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **errors** *(list) --*

          * *(dict) --*

            Error related to a specific channel, specified by its ARN.

            * **arn** *(string) --*

              ARN of an IVS resource; e.g., channel.

            * **code** *(string) --*

              Error code.

            * **message** *(string) --*

              Error message, determined by the application.

        * **streamKeys** *(list) --*

          * *(dict) --*

            Object specifying a stream key.

            * **arn** *(string) --*

              Stream-key ARN.

            * **channelArn** *(string) --*

              Channel ARN for the stream.

            * **tags** *(dict) --*

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

              * *(string) --*

                * *(string) --*

            * **value** *(string) --*

              Stream-key value.
IVS / Client / get_playback_restriction_policy


get_playback_restriction_policy
*******************************

IVS.Client.get_playback_restriction_policy(**kwargs)

   Gets the specified playback restriction policy.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_playback_restriction_policy(
          arn='string'
      )

   Parameters:
      **arn** (*string*) --

      **[REQUIRED]**

      ARN of the playback restriction policy to be returned.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'playbackRestrictionPolicy': {
                 'allowedCountries': [
                     'string',
                 ],
                 'allowedOrigins': [
                     'string',
                 ],
                 'arn': 'string',
                 'enableStrictOriginEnforcement': True|False,
                 'name': 'string',
                 'tags': {
                     'string': 'string'
                 }
             }
         }

      **Response Structure**

      * *(dict) --*

        * **playbackRestrictionPolicy** *(dict) --*

          * **allowedCountries** *(list) --*

            A list of country codes that control geoblocking
            restriction. Allowed values are the officially assigned
            ISO 3166-1 alpha-2 codes. Default: All countries (an empty
            array).

            * *(string) --*

          * **allowedOrigins** *(list) --*

            A list of origin sites that control CORS restriction.
            Allowed values are the same as valid values of the Origin
            header defined at https://developer.mozilla.org/en-
            US/docs/Web/HTTP/Headers/Origin. Default: All origins (an
            empty array).

            * *(string) --*

          * **arn** *(string) --*

            Playback-restriction-policy ARN

          * **enableStrictOriginEnforcement** *(boolean) --*

            Whether channel playback is constrained by origin site.
            Default: "false".

          * **name** *(string) --*

            Playback-restriction-policy name. The value does not need
            to be unique.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"
IVS / Client / tag_resource


tag_resource
************

IVS.Client.tag_resource(**kwargs)

   Adds or updates tags for the Amazon Web Services resource with the
   specified ARN.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.tag_resource(
          resourceArn='string',
          tags={
              'string': 'string'
          }
      )

   Parameters:
      * **resourceArn** (*string*) --

        **[REQUIRED]**

        ARN of the resource for which tags are to be added or updated.
        The ARN must be URL-encoded.

      * **tags** (*dict*) --

        **[REQUIRED]**

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

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {}

      **Response Structure**

      * *(dict) --*

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.InternalServerException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / get_stream_session


get_stream_session
******************

IVS.Client.get_stream_session(**kwargs)

   Gets metadata on a specified stream.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.get_stream_session(
          channelArn='string',
          streamId='string'
      )

   Parameters:
      * **channelArn** (*string*) --

        **[REQUIRED]**

        ARN of the channel resource

      * **streamId** (*string*) -- Unique identifier for a live or
        previously live stream in the specified channel. If no
        "streamId" is provided, this returns the most recent stream
        session for the channel, if it exists.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'streamSession': {
                 'channel': {
                     'arn': 'string',
                     'authorized': True|False,
                     'containerFormat': 'TS'|'FRAGMENTED_MP4',
                     'ingestEndpoint': 'string',
                     'insecureIngest': True|False,
                     'latencyMode': 'NORMAL'|'LOW',
                     'multitrackInputConfiguration': {
                         'enabled': True|False,
                         'maximumResolution': 'SD'|'HD'|'FULL_HD',
                         'policy': 'ALLOW'|'REQUIRE'
                     },
                     'name': 'string',
                     'playbackRestrictionPolicyArn': 'string',
                     'playbackUrl': 'string',
                     'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
                     'recordingConfigurationArn': 'string',
                     'srt': {
                         'endpoint': 'string',
                         'passphrase': 'string'
                     },
                     'tags': {
                         'string': 'string'
                     },
                     'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
                 },
                 'endTime': datetime(2015, 1, 1),
                 'ingestConfiguration': {
                     'audio': {
                         'channels': 123,
                         'codec': 'string',
                         'sampleRate': 123,
                         'targetBitrate': 123,
                         'track': 'string'
                     },
                     'video': {
                         'avcLevel': 'string',
                         'avcProfile': 'string',
                         'codec': 'string',
                         'encoder': 'string',
                         'level': 'string',
                         'profile': 'string',
                         'targetBitrate': 123,
                         'targetFramerate': 123,
                         'track': 'string',
                         'videoHeight': 123,
                         'videoWidth': 123
                     }
                 },
                 'ingestConfigurations': {
                     'audioConfigurations': [
                         {
                             'channels': 123,
                             'codec': 'string',
                             'sampleRate': 123,
                             'targetBitrate': 123,
                             'track': 'string'
                         },
                     ],
                     'videoConfigurations': [
                         {
                             'avcLevel': 'string',
                             'avcProfile': 'string',
                             'codec': 'string',
                             'encoder': 'string',
                             'level': 'string',
                             'profile': 'string',
                             'targetBitrate': 123,
                             'targetFramerate': 123,
                             'track': 'string',
                             'videoHeight': 123,
                             'videoWidth': 123
                         },
                     ]
                 },
                 'recordingConfiguration': {
                     'arn': 'string',
                     'destinationConfiguration': {
                         's3': {
                             'bucketName': 'string'
                         }
                     },
                     'name': 'string',
                     'recordingReconnectWindowSeconds': 123,
                     'renditionConfiguration': {
                         'renditionSelection': 'ALL'|'NONE'|'CUSTOM',
                         'renditions': [
                             'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
                         ]
                     },
                     'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
                     'tags': {
                         'string': 'string'
                     },
                     'thumbnailConfiguration': {
                         'recordingMode': 'DISABLED'|'INTERVAL',
                         'resolution': 'SD'|'HD'|'FULL_HD'|'LOWEST_RESOLUTION',
                         'storage': [
                             'SEQUENTIAL'|'LATEST',
                         ],
                         'targetIntervalSeconds': 123
                     }
                 },
                 'startTime': datetime(2015, 1, 1),
                 'streamId': 'string',
                 'truncatedEvents': [
                     {
                         'code': 'string',
                         'eventTime': datetime(2015, 1, 1),
                         'name': 'string',
                         'type': 'string'
                     },
                 ]
             }
         }

      **Response Structure**

      * *(dict) --*

        * **streamSession** *(dict) --*

          List of stream details.

          * **channel** *(dict) --*

            The properties of the channel at the time of going live.

            * **arn** *(string) --*

              Channel ARN.

            * **authorized** *(boolean) --*

              Whether the channel is private (enabled for playback
              authorization). Default: "false".

            * **containerFormat** *(string) --*

              Indicates which content-packaging format is used (MPEG-
              TS or fMP4). If "multitrackInputConfiguration" is
              specified and "enabled" is "true", then
              "containerFormat" is required and must be set to
              "FRAGMENTED_MP4". Otherwise, "containerFormat" may be
              set to "TS" or "FRAGMENTED_MP4". Default: "TS".

            * **ingestEndpoint** *(string) --*

              Channel ingest endpoint, part of the definition of an
              ingest server, used when you set up streaming software.

            * **insecureIngest** *(boolean) --*

              Whether the channel allows insecure RTMP ingest.
              Default: "false".

            * **latencyMode** *(string) --*

              Channel latency mode. Use "NORMAL" to broadcast and
              deliver live video up to Full HD. Use "LOW" for near-
              real-time interaction with viewers. Default: "LOW".

            * **multitrackInputConfiguration** *(dict) --*

              Object specifying multitrack input configuration.
              Default: no multitrack input configuration is specified.

              * **enabled** *(boolean) --*

                Indicates whether multitrack input is enabled. Can be
                set to "true" only if channel type is "STANDARD".
                Setting "enabled" to "true" with any other channel
                type will cause an exception. If "true", then
                "policy", "maximumResolution", and "containerFormat"
                are required, and "containerFormat" must be set to
                "FRAGMENTED_MP4". Default: "false".

              * **maximumResolution** *(string) --*

                Maximum resolution for multitrack input. Required if
                "enabled" is "true".

              * **policy** *(string) --*

                Indicates whether multitrack input is allowed or
                required. Required if "enabled" is "true".

            * **name** *(string) --*

              Channel name.

            * **playbackRestrictionPolicyArn** *(string) --*

              Playback-restriction-policy ARN. A valid ARN value here
              both specifies the ARN and enables playback restriction.
              Default: "" (empty string, no playback restriction
              policy is applied).

            * **playbackUrl** *(string) --*

              Channel playback URL.

            * **preset** *(string) --*

              Optional transcode preset for the channel. This is
              selectable only for "ADVANCED_HD" and "ADVANCED_SD"
              channel types. For those channel types, the default
              "preset" is "HIGHER_BANDWIDTH_DELIVERY". For other
              channel types ( "BASIC" and "STANDARD"), "preset" is the
              empty string ( """").

            * **recordingConfigurationArn** *(string) --*

              Recording-configuration ARN. A valid ARN value here both
              specifies the ARN and enables recording. Default: ""
              (empty string, recording is disabled).

            * **srt** *(dict) --*

              Specifies the endpoint and optional passphrase for
              streaming with the SRT protocol.

              * **endpoint** *(string) --*

                The endpoint to be used when streaming with IVS using
                the SRT protocol.

              * **passphrase** *(string) --*

                Auto-generated passphrase to enable encryption. This
                field is applicable only if the end user has *not*
                enabled the "insecureIngest" option for the channel.

            * **tags** *(dict) --*

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

              * *(string) --*

                * *(string) --*

            * **type** *(string) --*

              Channel type, which determines the allowable resolution
              and bitrate. *If you exceed the allowable input
              resolution or bitrate, the stream probably will
              disconnect immediately.* Default: "STANDARD". For
              details, see Channel Types.

          * **endTime** *(datetime) --*

            Time when the channel went offline. This is an ISO 8601
            timestamp; *note that this is returned as a string*. For
            live streams, this is "NULL".

          * **ingestConfiguration** *(dict) --*

            The properties of the incoming RTMP stream.

            **Note:** "ingestConfiguration" is deprecated in favor of
            "ingestConfigurations" but retained to ensure backward
            compatibility. If multitrack is not enabled,
            "ingestConfiguration" and "ingestConfigurations" contain
            the same data, namely information about track0 (the sole
            track). If multitrack is enabled, "ingestConfiguration"
            contains data for only the first track (track0) and
            "ingestConfigurations" contains data for all tracks.

            * **audio** *(dict) --*

              Encoder settings for audio.

              * **channels** *(integer) --*

                Number of audio channels.

              * **codec** *(string) --*

                Codec used for the audio encoding.

              * **sampleRate** *(integer) --*

                Number of audio samples recorded per second.

              * **targetBitrate** *(integer) --*

                The expected ingest bitrate (bits per second). This is
                configured in the encoder.

              * **track** *(string) --*

                Name of the audio track (if the stream has an audio
                track). If multitrack is not enabled, this is track0
                (the sole track).

            * **video** *(dict) --*

              Encoder settings for video.

              * **avcLevel** *(string) --*

                Indicates the degree of required decoder performance
                for a profile. Normally this is set automatically by
                the encoder. For details, see the H.264 specification.

              * **avcProfile** *(string) --*

                Indicates to the decoder the requirements for decoding
                the stream. For definitions of the valid values, see
                the H.264 specification.

              * **codec** *(string) --*

                Codec used for the video encoding.

              * **encoder** *(string) --*

                Software or hardware used to encode the video.

              * **level** *(string) --*

                Indicates the degree of required decoder performance
                for a profile. Normally this is set automatically by
                the encoder. When an AVC codec is used, this field has
                the same value as "avcLevel".

              * **profile** *(string) --*

                Indicates to the decoder the requirements for decoding
                the stream. When an AVC codec is used, this field has
                the same value as "avcProfile".

              * **targetBitrate** *(integer) --*

                The expected ingest bitrate (bits per second). This is
                configured in the encoder.

              * **targetFramerate** *(integer) --*

                The expected ingest framerate. This is configured in
                the encoder.

              * **track** *(string) --*

                Name of the video track. If multitrack is not enabled,
                this is track0 (the sole track).

              * **videoHeight** *(integer) --*

                Video-resolution height in pixels.

              * **videoWidth** *(integer) --*

                Video-resolution width in pixels.

          * **ingestConfigurations** *(dict) --*

            The properties of the incoming RTMP stream. If multitrack
            is enabled, "ingestConfigurations" contains data for all
            tracks; otherwise, it contains data only for track0 (the
            sole track).

            * **audioConfigurations** *(list) --*

              Encoder settings for audio.

              * *(dict) --*

                Object specifying a stream’s audio configuration, as
                set up by the broadcaster (usually in an encoder).
                This is part of the  IngestConfigurations object and
                the deprecated  IngestConfiguration object. It is used
                for monitoring stream health.

                * **channels** *(integer) --*

                  Number of audio channels.

                * **codec** *(string) --*

                  Codec used for the audio encoding.

                * **sampleRate** *(integer) --*

                  Number of audio samples recorded per second.

                * **targetBitrate** *(integer) --*

                  The expected ingest bitrate (bits per second). This
                  is configured in the encoder.

                * **track** *(string) --*

                  Name of the audio track (if the stream has an audio
                  track). If multitrack is not enabled, this is track0
                  (the sole track).

            * **videoConfigurations** *(list) --*

              Encoder settings for video

              * *(dict) --*

                Object specifying a stream’s video configuration, as
                set up by the broadcaster (usually in an encoder).
                This is part of the  IngestConfigurations object and
                the deprecated  IngestConfiguration object. It is used
                for monitoring stream health.

                * **avcLevel** *(string) --*

                  Indicates the degree of required decoder performance
                  for a profile. Normally this is set automatically by
                  the encoder. For details, see the H.264
                  specification.

                * **avcProfile** *(string) --*

                  Indicates to the decoder the requirements for
                  decoding the stream. For definitions of the valid
                  values, see the H.264 specification.

                * **codec** *(string) --*

                  Codec used for the video encoding.

                * **encoder** *(string) --*

                  Software or hardware used to encode the video.

                * **level** *(string) --*

                  Indicates the degree of required decoder performance
                  for a profile. Normally this is set automatically by
                  the encoder. When an AVC codec is used, this field
                  has the same value as "avcLevel".

                * **profile** *(string) --*

                  Indicates to the decoder the requirements for
                  decoding the stream. When an AVC codec is used, this
                  field has the same value as "avcProfile".

                * **targetBitrate** *(integer) --*

                  The expected ingest bitrate (bits per second). This
                  is configured in the encoder.

                * **targetFramerate** *(integer) --*

                  The expected ingest framerate. This is configured in
                  the encoder.

                * **track** *(string) --*

                  Name of the video track. If multitrack is not
                  enabled, this is track0 (the sole track).

                * **videoHeight** *(integer) --*

                  Video-resolution height in pixels.

                * **videoWidth** *(integer) --*

                  Video-resolution width in pixels.

          * **recordingConfiguration** *(dict) --*

            The properties of recording the live stream.

            * **arn** *(string) --*

              Recording-configuration ARN.

            * **destinationConfiguration** *(dict) --*

              A complex type that contains information about where
              recorded video will be stored.

              * **s3** *(dict) --*

                An S3 destination configuration where recorded videos
                will be stored.

                * **bucketName** *(string) --*

                  Location (S3 bucket name) where recorded videos will
                  be stored.

            * **name** *(string) --*

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

            * **recordingReconnectWindowSeconds** *(integer) --*

              If a broadcast disconnects and then reconnects within
              the specified interval, the multiple streams will be
              considered a single broadcast and merged together.
              Default: 0.

            * **renditionConfiguration** *(dict) --*

              Object that describes which renditions should be
              recorded for a stream.

              * **renditionSelection** *(string) --*

                Indicates which set of renditions are recorded for a
                stream. For "BASIC" channels, the "CUSTOM" value has
                no effect. If "CUSTOM" is specified, a set of
                renditions must be specified in the "renditions"
                field. Default: "ALL".

              * **renditions** *(list) --*

                Indicates which renditions are recorded for a stream,
                if "renditionSelection" is "CUSTOM"; otherwise, this
                field is irrelevant. The selected renditions are
                recorded if they are available during the stream. If a
                selected rendition is unavailable, the best available
                rendition is recorded. For details on the resolution
                dimensions of each rendition, see Auto-Record to
                Amazon S3.

                * *(string) --*

            * **state** *(string) --*

              Indicates the current state of the recording
              configuration. When the state is "ACTIVE", the
              configuration is ready for recording a channel stream.

            * **tags** *(dict) --*

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

              * *(string) --*

                * *(string) --*

            * **thumbnailConfiguration** *(dict) --*

              A complex type that allows you to enable/disable the
              recording of thumbnails for a live session and modify
              the interval at which thumbnails are generated for the
              live session.

              * **recordingMode** *(string) --*

                Thumbnail recording mode. Default: "INTERVAL".

              * **resolution** *(string) --*

                Indicates the desired resolution of recorded
                thumbnails. Thumbnails are recorded at the selected
                resolution if the corresponding rendition is available
                during the stream; otherwise, they are recorded at
                source resolution. For more information about
                resolution values and their corresponding height and
                width dimensions, see Auto-Record to Amazon S3.
                Default: Null (source resolution is returned).

              * **storage** *(list) --*

                Indicates the format in which thumbnails are recorded.
                "SEQUENTIAL" records all generated thumbnails in a
                serial manner, to the media/thumbnails directory.
                "LATEST" saves the latest thumbnail in
                media/latest_thumbnail/thumb.jpg and overwrites it at
                the interval specified by "targetIntervalSeconds". You
                can enable both "SEQUENTIAL" and "LATEST". Default:
                "SEQUENTIAL".

                * *(string) --*

              * **targetIntervalSeconds** *(integer) --*

                The targeted thumbnail-generation interval in seconds.
                This is configurable (and required) only if
                "recordingMode" is "INTERVAL". Default: 60.

                **Important:** For the "BASIC" channel type, or the
                "STANDARD" channel type with multitrack input, setting
                a value for "targetIntervalSeconds" does not guarantee
                that thumbnails are generated at the specified
                interval. For thumbnails to be generated at the
                "targetIntervalSeconds" interval, the "IDR/Keyframe"
                value for the input video must be less than the
                "targetIntervalSeconds" value. See Amazon IVS
                Streaming Configuration for information on setting
                "IDR/Keyframe" to the recommended value in video-
                encoder settings.

          * **startTime** *(datetime) --*

            Time when the channel went live. This is an ISO 8601
            timestamp; *note that this is returned as a string*.

          * **streamId** *(string) --*

            Unique identifier for a live or previously live stream in
            the specified channel.

          * **truncatedEvents** *(list) --*

            List of Amazon IVS events that the stream encountered. The
            list is sorted by most recent events and contains up to
            500 events. For Amazon IVS events, see Using Amazon
            EventBridge with Amazon IVS.

            * *(dict) --*

              Object specifying a stream’s events. For a list of
              events, see Using Amazon EventBridge with Amazon IVS.

              * **code** *(string) --*

                Provides additional details about the stream event.
                There are several values; the long descriptions are
                provided in the IVS console but not delivered through
                the IVS API or EventBridge. Multitrack-related codes
                are used only for certain Session Ended events.

                * "MultitrackInputNotAllowed" — The broadcast client
                  attempted to connect with multitrack input, but
                  multitrack input was not enabled on the channel.
                  Check your broadcast software settings or set
                  "MultitrackInputConfiguration.Policy" to "ALLOW" or
                  "REQUIRE".

                * "MultitrackInputRequired" — The broadcast client
                  attempted to connect with single-track video, but
                  multitrack input is required on this channel. Enable
                  multitrack video in your broadcast software or
                  configure the channel’s
                  "MultitrackInputConfiguration.Policy" to "ALLOW".

                * "InvalidGetClientConfigurationStreamKey" — The
                  broadcast client attempted to connect with an
                  invalid, expired, or corrupt stream key.

                * "GetClientConfigurationStreamKeyRequired" — The
                  broadcast client attempted to stream multitrack
                  video without providing an authenticated stream key
                  from GetClientConfiguration.

                * "InvalidMultitrackInputTrackCount" — The multitrack
                  input stream contained an invalid number of tracks.

                * "InvalidMultitrackInputVideoTrackMediaProperties" —
                  The multitrack input stream contained one or more
                  tracks with an invalid codec, resolution, bitrate,
                  or framerate.

                * "StreamTakeoverMediaMismatch" — The broadcast client
                  attempted to take over with different media
                  properties (e.g., codec, resolution, or video track
                  type) from the original stream.

                * "StreamTakeoverInvalidPriority" — The broadcast
                  client attempted a takeover with either a priority
                  integer value equal to or lower than the original
                  stream's value or a value outside the allowed range
                  of 1 to 2,147,483,647. "StreamTakeoverLimitBreached"
                  — The broadcast client reached the maximum allowed
                  takeover attempts for this stream.

              * **eventTime** *(datetime) --*

                Time when the event occurred. This is an ISO 8601
                timestamp; *note that this is returned as a string*.

              * **name** *(string) --*

                Name that identifies the stream event within a "type".

              * **type** *(string) --*

                Logical group for certain events.

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"
IVS / Client / update_channel


update_channel
**************

IVS.Client.update_channel(**kwargs)

   Updates a channel's configuration. Live channels cannot be updated.
   You must stop the ongoing stream, update the channel, and restart
   the stream for the changes to take effect.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.update_channel(
          arn='string',
          authorized=True|False,
          containerFormat='TS'|'FRAGMENTED_MP4',
          insecureIngest=True|False,
          latencyMode='NORMAL'|'LOW',
          multitrackInputConfiguration={
              'enabled': True|False,
              'maximumResolution': 'SD'|'HD'|'FULL_HD',
              'policy': 'ALLOW'|'REQUIRE'
          },
          name='string',
          playbackRestrictionPolicyArn='string',
          preset='HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
          recordingConfigurationArn='string',
          type='BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
      )

   Parameters:
      * **arn** (*string*) --

        **[REQUIRED]**

        ARN of the channel to be updated.

      * **authorized** (*boolean*) -- Whether the channel is private
        (enabled for playback authorization).

      * **containerFormat** (*string*) -- Indicates which content-
        packaging format is used (MPEG-TS or fMP4). If
        "multitrackInputConfiguration" is specified and "enabled" is
        "true", then "containerFormat" is required and must be set to
        "FRAGMENTED_MP4". Otherwise, "containerFormat" may be set to
        "TS" or "FRAGMENTED_MP4". Default: "TS".

      * **insecureIngest** (*boolean*) -- Whether the channel allows
        insecure RTMP and SRT ingest. Default: "false".

      * **latencyMode** (*string*) -- Channel latency mode. Use
        "NORMAL" to broadcast and deliver live video up to Full HD.
        Use "LOW" for near-real-time interaction with viewers.

      * **multitrackInputConfiguration** (*dict*) --

        Object specifying multitrack input configuration. Default: no
        multitrack input configuration is specified.

        * **enabled** *(boolean) --*

          Indicates whether multitrack input is enabled. Can be set to
          "true" only if channel type is "STANDARD". Setting "enabled"
          to "true" with any other channel type will cause an
          exception. If "true", then "policy", "maximumResolution",
          and "containerFormat" are required, and "containerFormat"
          must be set to "FRAGMENTED_MP4". Default: "false".

        * **maximumResolution** *(string) --*

          Maximum resolution for multitrack input. Required if
          "enabled" is "true".

        * **policy** *(string) --*

          Indicates whether multitrack input is allowed or required.
          Required if "enabled" is "true".

      * **name** (*string*) -- Channel name.

      * **playbackRestrictionPolicyArn** (*string*) -- Playback-
        restriction-policy ARN. A valid ARN value here both specifies
        the ARN and enables playback restriction. If this is set to an
        empty string, playback restriction policy is disabled.

      * **preset** (*string*) -- Optional transcode preset for the
        channel. This is selectable only for "ADVANCED_HD" and
        "ADVANCED_SD" channel types. For those channel types, the
        default "preset" is "HIGHER_BANDWIDTH_DELIVERY". For other
        channel types ( "BASIC" and "STANDARD"), "preset" is the empty
        string ( """").

      * **recordingConfigurationArn** (*string*) -- Recording-
        configuration ARN. A valid ARN value here both specifies the
        ARN and enables recording. If this is set to an empty string,
        recording is disabled.

      * **type** (*string*) -- Channel type, which determines the
        allowable resolution and bitrate. *If you exceed the allowable
        input resolution or bitrate, the stream probably will
        disconnect immediately.* Default: "STANDARD". For details, see
        Channel Types.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'channel': {
                 'arn': 'string',
                 'authorized': True|False,
                 'containerFormat': 'TS'|'FRAGMENTED_MP4',
                 'ingestEndpoint': 'string',
                 'insecureIngest': True|False,
                 'latencyMode': 'NORMAL'|'LOW',
                 'multitrackInputConfiguration': {
                     'enabled': True|False,
                     'maximumResolution': 'SD'|'HD'|'FULL_HD',
                     'policy': 'ALLOW'|'REQUIRE'
                 },
                 'name': 'string',
                 'playbackRestrictionPolicyArn': 'string',
                 'playbackUrl': 'string',
                 'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
                 'recordingConfigurationArn': 'string',
                 'srt': {
                     'endpoint': 'string',
                     'passphrase': 'string'
                 },
                 'tags': {
                     'string': 'string'
                 },
                 'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **channel** *(dict) --*

          Object specifying the updated channel.

          * **arn** *(string) --*

            Channel ARN.

          * **authorized** *(boolean) --*

            Whether the channel is private (enabled for playback
            authorization). Default: "false".

          * **containerFormat** *(string) --*

            Indicates which content-packaging format is used (MPEG-TS
            or fMP4). If "multitrackInputConfiguration" is specified
            and "enabled" is "true", then "containerFormat" is
            required and must be set to "FRAGMENTED_MP4". Otherwise,
            "containerFormat" may be set to "TS" or "FRAGMENTED_MP4".
            Default: "TS".

          * **ingestEndpoint** *(string) --*

            Channel ingest endpoint, part of the definition of an
            ingest server, used when you set up streaming software.

          * **insecureIngest** *(boolean) --*

            Whether the channel allows insecure RTMP ingest. Default:
            "false".

          * **latencyMode** *(string) --*

            Channel latency mode. Use "NORMAL" to broadcast and
            deliver live video up to Full HD. Use "LOW" for near-real-
            time interaction with viewers. Default: "LOW".

          * **multitrackInputConfiguration** *(dict) --*

            Object specifying multitrack input configuration. Default:
            no multitrack input configuration is specified.

            * **enabled** *(boolean) --*

              Indicates whether multitrack input is enabled. Can be
              set to "true" only if channel type is "STANDARD".
              Setting "enabled" to "true" with any other channel type
              will cause an exception. If "true", then "policy",
              "maximumResolution", and "containerFormat" are required,
              and "containerFormat" must be set to "FRAGMENTED_MP4".
              Default: "false".

            * **maximumResolution** *(string) --*

              Maximum resolution for multitrack input. Required if
              "enabled" is "true".

            * **policy** *(string) --*

              Indicates whether multitrack input is allowed or
              required. Required if "enabled" is "true".

          * **name** *(string) --*

            Channel name.

          * **playbackRestrictionPolicyArn** *(string) --*

            Playback-restriction-policy ARN. A valid ARN value here
            both specifies the ARN and enables playback restriction.
            Default: "" (empty string, no playback restriction policy
            is applied).

          * **playbackUrl** *(string) --*

            Channel playback URL.

          * **preset** *(string) --*

            Optional transcode preset for the channel. This is
            selectable only for "ADVANCED_HD" and "ADVANCED_SD"
            channel types. For those channel types, the default
            "preset" is "HIGHER_BANDWIDTH_DELIVERY". For other channel
            types ( "BASIC" and "STANDARD"), "preset" is the empty
            string ( """").

          * **recordingConfigurationArn** *(string) --*

            Recording-configuration ARN. A valid ARN value here both
            specifies the ARN and enables recording. Default: ""
            (empty string, recording is disabled).

          * **srt** *(dict) --*

            Specifies the endpoint and optional passphrase for
            streaming with the SRT protocol.

            * **endpoint** *(string) --*

              The endpoint to be used when streaming with IVS using
              the SRT protocol.

            * **passphrase** *(string) --*

              Auto-generated passphrase to enable encryption. This
              field is applicable only if the end user has *not*
              enabled the "insecureIngest" option for the channel.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

          * **type** *(string) --*

            Channel type, which determines the allowable resolution
            and bitrate. *If you exceed the allowable input resolution
            or bitrate, the stream probably will disconnect
            immediately.* Default: "STANDARD". For details, see
            Channel Types.

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ConflictException"
IVS / Client / list_playback_restriction_policies


list_playback_restriction_policies
**********************************

IVS.Client.list_playback_restriction_policies(**kwargs)

   Gets summary information about playback restriction policies.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.list_playback_restriction_policies(
          maxResults=123,
          nextToken='string'
      )

   Parameters:
      * **maxResults** (*integer*) -- Maximum number of policies to
        return. Default: 1.

      * **nextToken** (*string*) -- The first policy to retrieve. This
        is used for pagination; see the "nextToken" response field.

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'nextToken': 'string',
             'playbackRestrictionPolicies': [
                 {
                     'allowedCountries': [
                         'string',
                     ],
                     'allowedOrigins': [
                         'string',
                     ],
                     'arn': 'string',
                     'enableStrictOriginEnforcement': True|False,
                     'name': 'string',
                     'tags': {
                         'string': 'string'
                     }
                 },
             ]
         }

      **Response Structure**

      * *(dict) --*

        * **nextToken** *(string) --*

          If there are more channels than "maxResults", use
          "nextToken" in the request to get the next set.

        * **playbackRestrictionPolicies** *(list) --*

          List of the matching policies.

          * *(dict) --*

            Summary information about a PlaybackRestrictionPolicy.

            * **allowedCountries** *(list) --*

              A list of country codes that control geoblocking
              restriction. Allowed values are the officially assigned
              ISO 3166-1 alpha-2 codes. Default: All countries (an
              empty array).

              * *(string) --*

            * **allowedOrigins** *(list) --*

              A list of origin sites that control CORS restriction.
              Allowed values are the same as valid values of the
              Origin header defined at https://developer.mozilla.org
              /en-US/docs/Web/HTTP/Headers/Origin. Default: All
              origins (an empty array).

              * *(string) --*

            * **arn** *(string) --*

              Playback-restriction-policy ARN

            * **enableStrictOriginEnforcement** *(boolean) --*

              Whether channel playback is constrained by origin site.
              Default: "false".

            * **name** *(string) --*

              Playback-restriction-policy name. The value does not
              need to be unique.

            * **tags** *(dict) --*

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

              * *(string) --*

                * *(string) --*

   **Exceptions**

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ConflictException"
IVS / Client / create_stream_key


create_stream_key
*****************

IVS.Client.create_stream_key(**kwargs)

   Creates a stream key, used to initiate a stream, for the specified
   channel ARN.

   Note that  CreateChannel creates a stream key. If you subsequently
   use CreateStreamKey on the same channel, it will fail because a
   stream key already exists and there is a limit of 1 stream key per
   channel. To reset the stream key on a channel, use  DeleteStreamKey
   and then CreateStreamKey.

   See also: AWS API Documentation

   **Request Syntax**

      response = client.create_stream_key(
          channelArn='string',
          tags={
              'string': 'string'
          }
      )

   Parameters:
      * **channelArn** (*string*) --

        **[REQUIRED]**

        ARN of the channel for which to create the stream key.

      * **tags** (*dict*) --

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

        * *(string) --*

          * *(string) --*

   Return type:
      dict

   Returns:
      **Response Syntax**

         {
             'streamKey': {
                 'arn': 'string',
                 'channelArn': 'string',
                 'tags': {
                     'string': 'string'
                 },
                 'value': 'string'
             }
         }

      **Response Structure**

      * *(dict) --*

        * **streamKey** *(dict) --*

          Stream key used to authenticate an RTMPS stream for
          ingestion.

          * **arn** *(string) --*

            Stream-key ARN.

          * **channelArn** *(string) --*

            Channel ARN for the stream.

          * **tags** *(dict) --*

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

            * *(string) --*

              * *(string) --*

          * **value** *(string) --*

            Stream-key value.

   **Exceptions**

   * "IVS.Client.exceptions.ResourceNotFoundException"

   * "IVS.Client.exceptions.AccessDeniedException"

   * "IVS.Client.exceptions.ValidationException"

   * "IVS.Client.exceptions.PendingVerification"

   * "IVS.Client.exceptions.ServiceQuotaExceededException"