Skip to content

describe_mapped_resource_configuration

describe_mapped_resource_configuration(
    *,
    config_overrides: Optional[KinesisVideoClientConfig] = None,
    stream_name: Optional[StreamName] = None,
    stream_arn: Optional[ResourceARN] = None,
    max_results: Optional[MappedResourceConfigurationListLimit] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeMappedResourceConfigurationOutput

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

Parameters:

Raises:

Source code in docs_src/capo_kinesis_video/_services/kinesis_video.py
def describe_mapped_resource_configuration(
    self,
    *,
    config_overrides: Optional[KinesisVideoClientConfig] = None,
    stream_name: Optional["capo_kinesis_video.types.stream_name.StreamName"] = None,
    stream_arn: Optional[
        "capo_kinesis_video.types.resource_arn.ResourceARN"
    ] = None,
    max_results: Optional[
        "capo_kinesis_video.types.mapped_resource_configuration_list_limit.MappedResourceConfigurationListLimit"
    ] = None,
    next_token: Optional["capo_kinesis_video.types.next_token.NextToken"] = None,
) -> "capo_kinesis_video.types.describe_mapped_resource_configuration_output.DescribeMappedResourceConfigurationOutput":
    """<p>Returns the most current information about the stream. The <code>streamName</code> or <code>streamARN</code> should be provided in the input.</p>

    Args:
        stream_name: <p>The name of the stream.</p>
        stream_arn: <p>The Amazon Resource Name (ARN) of the stream.</p>
        max_results: <p>The maximum number of results to return in the response.</p>
        next_token: <p>The token to provide in your next request, to get another batch of results.</p>

    Raises:
        capo_kinesis_video.errors.access_denied_exception.AccessDeniedException: <p>You do not have required permissions to perform this operation.</p>
        capo_kinesis_video.errors.client_limit_exceeded_exception.ClientLimitExceededException: <p>Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.</p>
        capo_kinesis_video.errors.invalid_argument_exception.InvalidArgumentException: <p>The value for this input parameter is invalid.</p>
        capo_kinesis_video.errors.resource_not_found_exception.ResourceNotFoundException: <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
        capo_kinesis_video.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kinesis_video.types.describe_mapped_resource_configuration_input.DescribeMappedResourceConfigurationInput]",
    ) -> OperationResponse[
        "capo_kinesis_video.types.describe_mapped_resource_configuration_output.DescribeMappedResourceConfigurationOutput"
    ]:
        import capo_kinesis_video._operations.kinesis_video_20170930.describe_mapped_resource_configuration

        output, http_response = (
            capo_kinesis_video._operations.kinesis_video_20170930.describe_mapped_resource_configuration.describe_mapped_resource_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeMappedResourceConfiguration")
    )
    input_: capo_kinesis_video.types.describe_mapped_resource_configuration_input.DescribeMappedResourceConfigurationInput = {}
    if stream_name is not None:
        input_["stream_name"] = stream_name
    if stream_arn is not None:
        input_["stream_arn"] = stream_arn
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output