list_edge_agent_configurations ¶

def list_edge_agent_configurations(
    self,
    hub_device_arn: "capo_kinesis_video.types.hub_device_arn.HubDeviceArn",
    *,
    config_overrides: Optional[KinesisVideoClientConfig] = None,
    max_results: Optional[
        "capo_kinesis_video.types.list_edge_agent_configurations_input_limit.ListEdgeAgentConfigurationsInputLimit"
    ] = None,
    next_token: Optional["capo_kinesis_video.types.next_token.NextToken"] = None,
) -> "capo_kinesis_video.types.list_edge_agent_configurations_output.ListEdgeAgentConfigurationsOutput":
    """<p>Returns an array of edge configurations associated with the specified Edge Agent.</p> <p>In the request, you must specify the Edge Agent <code>HubDeviceArn</code>.</p>

    Args:
        hub_device_arn: <p>The "Internet of Things (IoT) Thing" Arn of the edge agent.</p>
        max_results: <p>The maximum number of edge configurations to return in the response. The default is 5.</p>
        next_token: <p>If you specify this parameter, when the result of a <code>ListEdgeAgentConfigurations</code> operation is truncated, the call returns the <code>NextToken</code> in the response. To get another batch of edge configurations, provide this token in your next request. </p>

    Raises:
        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.not_authorized_exception.NotAuthorizedException: <p>The caller is not authorized to perform this operation.</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.list_edge_agent_configurations_input.ListEdgeAgentConfigurationsInput]",
    ) -> OperationResponse[
        "capo_kinesis_video.types.list_edge_agent_configurations_output.ListEdgeAgentConfigurationsOutput"
    ]:
        import capo_kinesis_video._operations.kinesis_video_20170930.list_edge_agent_configurations

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

    def _redact_output(
        output: "capo_kinesis_video.types.list_edge_agent_configurations_output.ListEdgeAgentConfigurationsOutput",
    ) -> dict[str, Any]:
        import capo_kinesis_video.types.list_edge_agent_configurations_output

        return capo_kinesis_video.types.list_edge_agent_configurations_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListEdgeAgentConfigurations", redact_output=_redact_output
        ),
    )
    input_: capo_kinesis_video.types.list_edge_agent_configurations_input.ListEdgeAgentConfigurationsInput = {
        "hub_device_arn": hub_device_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