list_stream_keys `async` ¶

list_stream_keys(
    channel_arn: ChannelArn,
    *,
    config_overrides: Optional[AsyncivsClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxStreamKeyResults] = None,
) -> ListStreamKeysResponse

Gets summary information about stream keys for the specified channel.

Parameters:

channel_arn (ChannelArn) –

Channel ARN used to filter the list.
next_token (Optional[PaginationToken], default: None ) –

The first stream key to retrieve. This is used for pagination; see the nextToken response field.
max_results (Optional[MaxStreamKeyResults], default: None ) –

Maximum number of streamKeys to return. Default: 1.

Raises:

AccessDeniedException –

User does not have sufficient access to perform this action.
ResourceNotFoundException –

Request references a resource which does not exist.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ivs/_services/async_ivs.py

async def list_stream_keys(
    self,
    channel_arn: "capo_ivs.types.channel_arn.ChannelArn",
    *,
    config_overrides: Optional[AsyncivsClientConfig] = None,
    next_token: Optional["capo_ivs.types.pagination_token.PaginationToken"] = None,
    max_results: Optional[
        "capo_ivs.types.max_stream_key_results.MaxStreamKeyResults"
    ] = None,
) -> "capo_ivs.types.list_stream_keys_response.ListStreamKeysResponse":
    """<p>Gets summary information about stream keys for the specified channel.</p>

    Args:
        channel_arn: <p>Channel ARN used to filter the list.</p>
        next_token: <p>The first stream key to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
        max_results: <p>Maximum number of streamKeys to return. Default: 1.</p>

    Raises:
        capo_ivs.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_ivs.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_ivs.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ivs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ivs.types.list_stream_keys_request.ListStreamKeysRequest]",
    ) -> AsyncOperationResponse[
        "capo_ivs.types.list_stream_keys_response.ListStreamKeysResponse"
    ]:
        import capo_ivs._operations.amazon_interactive_video_service.list_stream_keys

        (
            output,
            http_response,
        ) = await capo_ivs._operations.amazon_interactive_video_service.list_stream_keys.async_list_stream_keys(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListStreamKeys")
    )
    input_: capo_ivs.types.list_stream_keys_request.ListStreamKeysRequest = {
        "channel_arn": channel_arn
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_stream_keys async ¶

list_stream_keys `async` ¶