update_contact_flow_metadata ¶

def update_contact_flow_metadata(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    contact_flow_id: "capo_connect.types.contact_flow_id.ContactFlowId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    name: Optional["capo_connect.types.contact_flow_name.ContactFlowName"] = None,
    description: Optional[
        "capo_connect.types.contact_flow_description.ContactFlowDescription"
    ] = None,
    contact_flow_state: Optional[
        "capo_connect.types.contact_flow_state.ContactFlowState"
    ] = None,
) -> "capo_connect.types.update_contact_flow_metadata_response.UpdateContactFlowMetadataResponse":
    """<p>Updates metadata about specified flow.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        contact_flow_id: <p>The identifier of the flow.</p>
        name: <p>The name of the flow.</p>
        description: <p>The description of the flow.</p>
        contact_flow_state: <p>The state of flow.</p>

    Raises:
        capo_connect.errors.duplicate_resource_exception.DuplicateResourceException: <p>A resource with the specified name already exists.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.update_contact_flow_metadata_request.UpdateContactFlowMetadataRequest]",
    ) -> OperationResponse[
        "capo_connect.types.update_contact_flow_metadata_response.UpdateContactFlowMetadataResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.update_contact_flow_metadata

        output, http_response = (
            capo_connect._operations.amazon_connect_service.update_contact_flow_metadata.update_contact_flow_metadata(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateContactFlowMetadata")
    )
    input_: capo_connect.types.update_contact_flow_metadata_request.UpdateContactFlowMetadataRequest = {
        "instance_id": instance_id,
        "contact_flow_id": contact_flow_id,
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if contact_flow_state is not None:
        input_["contact_flow_state"] = contact_flow_state

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