update_capability ¶

def update_capability(
    self,
    capability_id: "capo_b2bi.types.capability_id.CapabilityId",
    *,
    config_overrides: Optional[b2biClientConfig] = None,
    name: Optional["capo_b2bi.types.capability_name.CapabilityName"] = None,
    configuration: Optional[
        "capo_b2bi.types.capability_configuration.CapabilityConfiguration"
    ] = None,
    instructions_documents: Optional[
        "capo_b2bi.types.instructions_documents.InstructionsDocuments"
    ] = None,
) -> "capo_b2bi.types.update_capability_response.UpdateCapabilityResponse":
    """<p>Updates some of the parameters for a capability, based on the specified parameters. 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>
        name: <p>Specifies a new name for the capability, to replace the existing name.</p>
        configuration: <p>Specifies a structure that contains the details for a capability.</p>
        instructions_documents: <p>Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.</p>

    Raises:
        capo_b2bi.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_b2bi.errors.conflict_exception.ConflictException: <p>A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.</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 UpdateCapability call

        >>> client.update_capability(capability_id='ca-963a8121e4fc4e348', name='b2biexample', instructions_documents=[{'bucketName': 'test-bucket', 'key': 'instructiondoc.txt'}], configuration={'edi': {'type': {'x12Details': {'transactionSet': 'X12_110', 'version': 'VERSION_4010'}}, 'inputLocation': {'bucketName': 'test-bucket', 'key': 'input/'}, 'outputLocation': {'bucketName': 'test-bucket', 'key': 'output/'}, 'transformerId': 'tr-9a893cf536df4658b'}})
    """

    def _handler(
        req: "OperationRequest[capo_b2bi.types.update_capability_request.UpdateCapabilityRequest]",
    ) -> OperationResponse[
        "capo_b2bi.types.update_capability_response.UpdateCapabilityResponse"
    ]:
        import capo_b2bi._operations.b2_bi.update_capability

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateCapability")
    )
    input_: capo_b2bi.types.update_capability_request.UpdateCapabilityRequest = {
        "capability_id": capability_id
    }
    if name is not None:
        input_["name"] = name
    if configuration is not None:
        input_["configuration"] = configuration
    if instructions_documents is not None:
        input_["instructions_documents"] = instructions_documents

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