KinesisVideo / Client / describe_mapped_resource_configuration

describe_mapped_resource_configuration#

KinesisVideo.Client.describe_mapped_resource_configuration(**kwargs)#

Returns the most current information about the stream. Either streamName or streamARN should be provided in the input.

Returns the most current information about the stream. The streamName or streamARN should be provided in the input.

Request Syntax

response = client.describe_mapped_resource_configuration(
    StreamName='string',
    StreamARN='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

StreamName (string) – The name of the stream.
StreamARN (string) – The Amazon Resource Name (ARN) of the stream.
MaxResults (integer) – The maximum number of results to return in the response.
NextToken (string) – The token to provide in your next request, to get another batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'MappedResourceConfigurationList': [
        {
            'Type': 'string',
            'ARN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- MappedResourceConfigurationList (list) –
  
  A structure that encapsulates, or contains, the media storage configuration properties.
  - (dict) –
    
    A structure that encapsulates, or contains, the media storage configuration properties.
    - Type (string) –
      
      The type of the associated resource for the kinesis video stream.
    - ARN (string) –
      
      The Amazon Resource Name (ARN) of the Kinesis Video Stream resource, associated with the stream.
- NextToken (string) –
  
  The token that was used in the ``NextToken``request to fetch the next set of results.

Exceptions

KinesisVideo.Client.exceptions.ResourceNotFoundException
KinesisVideo.Client.exceptions.InvalidArgumentException
KinesisVideo.Client.exceptions.AccessDeniedException
KinesisVideo.Client.exceptions.ClientLimitExceededException