Skip to content

get_telemetry_metadata

get_telemetry_metadata(
    assessment_run_arn: Arn, *, config_overrides: Optional[InspectorClientConfig] = None
) -> GetTelemetryMetadataResponse

Information about the data that is collected for the specified assessment run.

Parameters:

  • assessment_run_arn (Arn) –

    The ARN that specifies the assessment run that has the telemetry data that you want to obtain.

Raises:

  • AccessDeniedException –

    You do not have required permissions to access the requested resource.

  • InternalException –

    Internal server error.

  • InvalidInputException –

    The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

  • NoSuchEntityException –

    The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

  • UnknownServiceError –

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

Examples:

Get telemetry metadata Information about the data that is collected for the specified assessment run.

>>> client.get_telemetry_metadata(assessment_run_arn='arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE')
Source code in docs_src/capo_inspector/_services/inspector.py
def get_telemetry_metadata(
    self,
    assessment_run_arn: "capo_inspector.types.arn.Arn",
    *,
    config_overrides: Optional[InspectorClientConfig] = None,
) -> "capo_inspector.types.get_telemetry_metadata_response.GetTelemetryMetadataResponse":
    """<p>Information about the data that is collected for the specified assessment run.</p>

    Args:
        assessment_run_arn: <p>The ARN that specifies the assessment run that has the telemetry data that you want to obtain.</p>

    Raises:
        capo_inspector.errors.access_denied_exception.AccessDeniedException: <p>You do not have required permissions to access the requested resource.</p>
        capo_inspector.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_inspector.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>
        capo_inspector.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced an entity that does not exist. The error code describes the entity.</p>
        capo_inspector.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get telemetry metadata
        Information about the data that is collected for the specified assessment run.

        >>> client.get_telemetry_metadata(assessment_run_arn='arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE')
    """

    def _handler(
        req: "OperationRequest[capo_inspector.types.get_telemetry_metadata_request.GetTelemetryMetadataRequest]",
    ) -> OperationResponse[
        "capo_inspector.types.get_telemetry_metadata_response.GetTelemetryMetadataResponse"
    ]:
        import capo_inspector._operations.inspector_service.get_telemetry_metadata

        output, http_response = (
            capo_inspector._operations.inspector_service.get_telemetry_metadata.get_telemetry_metadata(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTelemetryMetadata")
    )
    input_: capo_inspector.types.get_telemetry_metadata_request.GetTelemetryMetadataRequest = {
        "assessment_run_arn": assessment_run_arn
    }

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