Skip to content

delete_contact_flow_alias

delete_contact_flow_alias(
    instance_id: InstanceIdOrArn,
    contact_flow_id: ARN,
    alias_id: ResourceId,
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> DeleteContactFlowAliasResponse

Deletes an alias from a flow without deleting the version that the alias points to.

Parameters:

  • instance_id (InstanceIdOrArn) –

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • contact_flow_id (ARN) –

    The identifier of the flow.

  • alias_id (ResourceId) –

    The identifier of the alias.

Raises:

Source code in docs_src/capo_connect/_services/connect.py
def delete_contact_flow_alias(
    self,
    instance_id: "capo_connect.types.instance_id_or_arn.InstanceIdOrArn",
    contact_flow_id: "capo_connect.types.arn.ARN",
    alias_id: "capo_connect.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> "capo_connect.types.delete_contact_flow_alias_response.DeleteContactFlowAliasResponse":
    """<p>Deletes an alias from a flow without deleting the version that the alias points to.</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>
        alias_id: <p>The identifier of the alias.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</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.delete_contact_flow_alias_request.DeleteContactFlowAliasRequest]",
    ) -> OperationResponse[
        "capo_connect.types.delete_contact_flow_alias_response.DeleteContactFlowAliasResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.delete_contact_flow_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteContactFlowAlias")
    )
    input_: capo_connect.types.delete_contact_flow_alias_request.DeleteContactFlowAliasRequest = {
        "instance_id": instance_id,
        "contact_flow_id": contact_flow_id,
        "alias_id": alias_id,
    }

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