Skip to content

list_playback_restriction_policies async

list_playback_restriction_policies(
    *,
    config_overrides: Optional[AsyncivsClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxPlaybackRestrictionPolicyResults] = None,
) -> ListPlaybackRestrictionPoliciesResponse

Gets summary information about playback restriction policies.

Parameters:

Raises:

Source code in docs_src/capo_ivs/_services/async_ivs.py
async def list_playback_restriction_policies(
    self,
    *,
    config_overrides: Optional[AsyncivsClientConfig] = None,
    next_token: Optional["capo_ivs.types.pagination_token.PaginationToken"] = None,
    max_results: Optional[
        "capo_ivs.types.max_playback_restriction_policy_results.MaxPlaybackRestrictionPolicyResults"
    ] = None,
) -> "capo_ivs.types.list_playback_restriction_policies_response.ListPlaybackRestrictionPoliciesResponse":
    """<p>Gets summary information about playback restriction policies.</p>

    Args:
        next_token: <p>The first policy to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
        max_results: <p>Maximum number of policies 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.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_ivs.errors.pending_verification.PendingVerification: <p>Your account is pending verification.</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_playback_restriction_policies_request.ListPlaybackRestrictionPoliciesRequest]",
    ) -> AsyncOperationResponse[
        "capo_ivs.types.list_playback_restriction_policies_response.ListPlaybackRestrictionPoliciesResponse"
    ]:
        import capo_ivs._operations.amazon_interactive_video_service.list_playback_restriction_policies

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPlaybackRestrictionPolicies")
    )
    input_: capo_ivs.types.list_playback_restriction_policies_request.ListPlaybackRestrictionPoliciesRequest = {}
    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