com.amazonaws.services.connect.AmazonConnectAsync Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.connect;

import javax.annotation.Generated;

import com.amazonaws.services.connect.model.*;

/**
 * Interface for accessing Amazon Connect asynchronously. Each asynchronous method will return a Java Future object
 * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
 * notification when an asynchronous operation completes.
 * 
 * Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
 * {@link com.amazonaws.services.connect.AbstractAmazonConnectAsync} instead.
 * 
 * 
 * 

 * The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect
 * actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it
 * easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.
 * 
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonConnectAsync extends AmazonConnect {

    /**
     * 
     * The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
     * customer.
     * 
     * 
     * There is a throttling limit placed on usage of the API that includes a RateLimit of 2 per second,
     * and a BurstLimit of 5 per second.
     * 
     * 
     * If you are using an IAM account, it must have permissions to the connect:StartOutboundVoiceContact
     * action.
     * 
     * 
     * @param startOutboundVoiceContactRequest
     * @return A Java Future containing the result of the StartOutboundVoiceContact operation returned by the service.
     * @sample AmazonConnectAsync.StartOutboundVoiceContact
     * @see AWS API Documentation
     */
    java.util.concurrent.Future startOutboundVoiceContactAsync(
            StartOutboundVoiceContactRequest startOutboundVoiceContactRequest);

    /**
     * 
     * The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a
     * customer.
     * 
     * 
     * There is a throttling limit placed on usage of the API that includes a RateLimit of 2 per second,
     * and a BurstLimit of 5 per second.
     * 
     * 
     * If you are using an IAM account, it must have permissions to the connect:StartOutboundVoiceContact
     * action.
     * 
     * 
     * @param startOutboundVoiceContactRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the StartOutboundVoiceContact operation returned by the service.
     * @sample AmazonConnectAsyncHandler.StartOutboundVoiceContact
     * @see AWS API Documentation
     */
    java.util.concurrent.Future startOutboundVoiceContactAsync(
            StartOutboundVoiceContactRequest startOutboundVoiceContactRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

    /**
     * 
     * Ends the contact initiated by the StartOutboundVoiceContact operation.
     * 
     * 
     * If you are using an IAM account, it must have permissions to the connect:StopContact operation.
     * 
     * 
     * @param stopContactRequest
     * @return A Java Future containing the result of the StopContact operation returned by the service.
     * @sample AmazonConnectAsync.StopContact
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future stopContactAsync(StopContactRequest stopContactRequest);

    /**
     * 
     * Ends the contact initiated by the StartOutboundVoiceContact operation.
     * 
     * 
     * If you are using an IAM account, it must have permissions to the connect:StopContact operation.
     * 
     * 
     * @param stopContactRequest
     * @param asyncHandler
     *        Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
     *        implementation of the callback methods in this interface to receive notification of successful or
     *        unsuccessful completion of the operation.
     * @return A Java Future containing the result of the StopContact operation returned by the service.
     * @sample AmazonConnectAsyncHandler.StopContact
     * @see AWS API
     *      Documentation
     */
    java.util.concurrent.Future stopContactAsync(StopContactRequest stopContactRequest,
            com.amazonaws.handlers.AsyncHandler asyncHandler);

}