Skip to content

get_component async

get_component(
    app_id: str,
    environment_name: str,
    id: Uuid,
    *,
    config_overrides: Optional[AsyncAmplifyUIBuilderClientConfig] = None,
) -> GetComponentResponse

Returns an existing component for an Amplify app.

Parameters:

  • app_id (str) –

    The unique ID of the Amplify app.

  • environment_name (str) –

    The name of the backend environment that is part of the Amplify app.

  • id (Uuid) –

    The unique ID of the component.

Raises:

Source code in docs_src/capo_amplifyuibuilder/_services/async_amplify_ui_builder.py
async def get_component(
    self,
    app_id: str,
    environment_name: str,
    id: "capo_amplifyuibuilder.types.uuid.Uuid",
    *,
    config_overrides: Optional[AsyncAmplifyUIBuilderClientConfig] = None,
) -> "capo_amplifyuibuilder.types.get_component_response.GetComponentResponse":
    """<p>Returns an existing component for an Amplify app.</p>

    Args:
        app_id: <p>The unique ID of the Amplify app.</p>
        environment_name: <p>The name of the backend environment that is part of the Amplify app.</p>
        id: <p>The unique ID of the component.</p>

    Raises:
        capo_amplifyuibuilder.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred. Please retry your request.</p>
        capo_amplifyuibuilder.errors.invalid_parameter_exception.InvalidParameterException: <p>An invalid or out-of-range value was supplied for the input parameter.</p>
        capo_amplifyuibuilder.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_amplifyuibuilder.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_amplifyuibuilder.types.get_component_request.GetComponentRequest]",
    ) -> AsyncOperationResponse[
        "capo_amplifyuibuilder.types.get_component_response.GetComponentResponse"
    ]:
        import capo_amplifyuibuilder._operations.amplify_ui_builder.get_component

        (
            output,
            http_response,
        ) = await capo_amplifyuibuilder._operations.amplify_ui_builder.get_component.async_get_component(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetComponent")
    )
    input_: capo_amplifyuibuilder.types.get_component_request.GetComponentRequest = {
        "app_id": app_id,
        "environment_name": environment_name,
        "id": id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output