get_component ¶

get_component(
    name: ResourceName, *, config_overrides: Optional[ProtonClientConfig] = None
) -> GetComponentOutput

Get detailed data for a component.

For more information about components, see Proton components in the Proton User Guide.

Parameters:

name (ResourceName) –

The name of the component that you want to get the detailed data for.

Raises:

AccessDeniedException –

There isn't sufficient access for performing this action.
InternalServerException –

The request failed to register with the service.
ResourceNotFoundException –

The requested resource wasn't found.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input is invalid or an out-of-range value was supplied for the input parameter.
UnknownServiceError –

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

Source code in docs_src/capo_proton/_services/proton.py

def get_component(
    self,
    name: "capo_proton.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
) -> "capo_proton.types.get_component_output.GetComponentOutput":
    """<p>Get detailed data for a component.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p>

    Args:
        name: <p>The name of the component that you want to get the detailed data for.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.get_component_input.GetComponentInput]",
    ) -> OperationResponse[
        "capo_proton.types.get_component_output.GetComponentOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.get_component

        output, http_response = (
            capo_proton._operations.aws_proton20200720.get_component.get_component(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_proton.types.get_component_output.GetComponentOutput",
    ) -> dict[str, Any]:
        import capo_proton.types.get_component_output

        return capo_proton.types.get_component_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetComponent", redact_output=_redact_output),
    )
    input_: capo_proton.types.get_component_input.GetComponentInput = {"name": name}

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