Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
Parameters:
-
next_token
(Optional[PaginationToken], default:
None
)
–
The first key pair to retrieve. This is used for pagination; see the nextToken response field.
-
max_results
(Optional[MaxPlaybackKeyPairResults], default:
None
)
–
Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.
Raises:
Source code in docs_src/capo_ivs/_services/ivs.py
| def list_playback_key_pairs(
self,
*,
config_overrides: Optional[ivsClientConfig] = None,
next_token: Optional["capo_ivs.types.pagination_token.PaginationToken"] = None,
max_results: Optional[
"capo_ivs.types.max_playback_key_pair_results.MaxPlaybackKeyPairResults"
] = None,
) -> "capo_ivs.types.list_playback_key_pairs_response.ListPlaybackKeyPairsResponse":
"""<p>Gets summary information about playback key pairs. For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the <i>Amazon IVS User Guide</i>.</p>
Args:
next_token: <p>The first key pair to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
max_results: <p>Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.</p>
Raises:
capo_ivs.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</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.
"""
def _handler(
req: "OperationRequest[capo_ivs.types.list_playback_key_pairs_request.ListPlaybackKeyPairsRequest]",
) -> OperationResponse[
"capo_ivs.types.list_playback_key_pairs_response.ListPlaybackKeyPairsResponse"
]:
import capo_ivs._operations.amazon_interactive_video_service.list_playback_key_pairs
output, http_response = (
capo_ivs._operations.amazon_interactive_video_service.list_playback_key_pairs.list_playback_key_pairs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListPlaybackKeyPairs")
)
input_: capo_ivs.types.list_playback_key_pairs_request.ListPlaybackKeyPairsRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|