Skip to content

get_instance

get_instance(
    instance_id: UUID, *, config_overrides: Optional[SupplyChainClientConfig] = None
) -> GetInstanceResponse

Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.

Parameters:

  • instance_id (UUID) –

    The AWS Supply Chain instance identifier

Raises:

Examples:

Successful GetInstance request

>>> client.get_instance(instance_id='9e193580-7cc5-45f7-9609-c43ba0ada793')
Successful GetInstance request with error message
>>> client.get_instance(instance_id='9e193580-7cc5-45f7-9609-c43ba0ada793')
Source code in docs_src/capo_supplychain/_services/supply_chain.py
def get_instance(
    self,
    instance_id: "capo_supplychain.types.uuid.UUID",
    *,
    config_overrides: Optional[SupplyChainClientConfig] = None,
) -> "capo_supplychain.types.get_instance_response.GetInstanceResponse":
    """<p>Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.</p>

    Args:
        instance_id: <p>The AWS Supply Chain instance identifier</p>

    Raises:
        capo_supplychain.errors.access_denied_exception.AccessDeniedException: <p>You do not have the required privileges to perform this action.</p>
        capo_supplychain.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_supplychain.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_supplychain.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_supplychain.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</p>
        capo_supplychain.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_supplychain.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an AWS service.</p>
        capo_supplychain.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Successful GetInstance request

        >>> client.get_instance(instance_id='9e193580-7cc5-45f7-9609-c43ba0ada793')
        Successful GetInstance request with error message

        >>> client.get_instance(instance_id='9e193580-7cc5-45f7-9609-c43ba0ada793')
    """

    def _handler(
        req: "OperationRequest[capo_supplychain.types.get_instance_request.GetInstanceRequest]",
    ) -> OperationResponse[
        "capo_supplychain.types.get_instance_response.GetInstanceResponse"
    ]:
        import capo_supplychain._operations.galaxy_public_api_gateway.get_instance

        output, http_response = (
            capo_supplychain._operations.galaxy_public_api_gateway.get_instance.get_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetInstance")
    )
    input_: capo_supplychain.types.get_instance_request.GetInstanceRequest = {
        "instance_id": instance_id
    }

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