get_capability ¶

def get_capability(
    self,
    capability_id: "capo_b2bi.types.capability_id.CapabilityId",
    *,
    config_overrides: Optional[b2biClientConfig] = None,
) -> "capo_b2bi.types.get_capability_response.GetCapabilityResponse":
    """<p>Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>

    Args:
        capability_id: <p>Specifies a system-assigned unique identifier for the capability.</p>

    Raises:
        capo_b2bi.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_b2bi.errors.internal_server_exception.InternalServerException: <p>This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.</p>
        capo_b2bi.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.</p>
        capo_b2bi.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.</p>
        capo_b2bi.errors.validation_exception.ValidationException: <p>Occurs when a B2BI object cannot be validated against a request from another object. This exception can be thrown during standard EDI validation or when custom validation rules fail, such as when element length constraints are violated, invalid codes are used in code list validations, or required elements are missing based on configured element requirement rules.</p>
        capo_b2bi.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Sample GetCapabilty call

        >>> client.get_capability(capability_id='ca-963a8121e4fc4e348')
    """

    def _handler(
        req: "OperationRequest[capo_b2bi.types.get_capability_request.GetCapabilityRequest]",
    ) -> OperationResponse[
        "capo_b2bi.types.get_capability_response.GetCapabilityResponse"
    ]:
        import capo_b2bi._operations.b2_bi.get_capability

        output, http_response = (
            capo_b2bi._operations.b2_bi.get_capability.get_capability(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetCapability")
    )
    input_: capo_b2bi.types.get_capability_request.GetCapabilityRequest = {
        "capability_id": capability_id
    }

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