com.amazonaws.services.identitystore.AWSIdentityStoreAsync Maven / Gradle / Ivy
/*
* Copyright 2016-2021 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.identitystore;
import javax.annotation.Generated;
import com.amazonaws.services.identitystore.model.*;
/**
* Interface for accessing IdentityStore 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.identitystore.AbstractAWSIdentityStoreAsync} instead.
*
*
*
* The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your identities (users
* and groups). For more information about AWS, see the AWS Single Sign-On User Guide.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIdentityStoreAsync extends AWSIdentityStore {
/**
*
* Retrieves the group metadata and attributes from GroupId in an identity store.
*
*
* @param describeGroupRequest
* @return A Java Future containing the result of the DescribeGroup operation returned by the service.
* @sample AWSIdentityStoreAsync.DescribeGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeGroupAsync(DescribeGroupRequest describeGroupRequest);
/**
*
* Retrieves the group metadata and attributes from GroupId in an identity store.
*
*
* @param describeGroupRequest
* @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 DescribeGroup operation returned by the service.
* @sample AWSIdentityStoreAsyncHandler.DescribeGroup
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeGroupAsync(DescribeGroupRequest describeGroupRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the user metadata and attributes from UserId in an identity store.
*
*
* @param describeUserRequest
* @return A Java Future containing the result of the DescribeUser operation returned by the service.
* @sample AWSIdentityStoreAsync.DescribeUser
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeUserAsync(DescribeUserRequest describeUserRequest);
/**
*
* Retrieves the user metadata and attributes from UserId in an identity store.
*
*
* @param describeUserRequest
* @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 DescribeUser operation returned by the service.
* @sample AWSIdentityStoreAsyncHandler.DescribeUser
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeUserAsync(DescribeUserRequest describeUserRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the attribute name and value of the group that you specified in the search. We only support
* DisplayName as a valid filter attribute path currently, and filter is required. This API returns
* minimum attributes, including GroupId and group DisplayName in the response.
*
*
* @param listGroupsRequest
* @return A Java Future containing the result of the ListGroups operation returned by the service.
* @sample AWSIdentityStoreAsync.ListGroups
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listGroupsAsync(ListGroupsRequest listGroupsRequest);
/**
*
* Lists the attribute name and value of the group that you specified in the search. We only support
* DisplayName as a valid filter attribute path currently, and filter is required. This API returns
* minimum attributes, including GroupId and group DisplayName in the response.
*
*
* @param listGroupsRequest
* @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 ListGroups operation returned by the service.
* @sample AWSIdentityStoreAsyncHandler.ListGroups
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listGroupsAsync(ListGroupsRequest listGroupsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the attribute name and value of the user that you specified in the search. We only support
* UserName as a valid filter attribute path currently, and filter is required. This API returns
* minimum attributes, including UserId and UserName in the response.
*
*
* @param listUsersRequest
* @return A Java Future containing the result of the ListUsers operation returned by the service.
* @sample AWSIdentityStoreAsync.ListUsers
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listUsersAsync(ListUsersRequest listUsersRequest);
/**
*
* Lists the attribute name and value of the user that you specified in the search. We only support
* UserName as a valid filter attribute path currently, and filter is required. This API returns
* minimum attributes, including UserId and UserName in the response.
*
*
* @param listUsersRequest
* @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 ListUsers operation returned by the service.
* @sample AWSIdentityStoreAsyncHandler.ListUsers
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listUsersAsync(ListUsersRequest listUsersRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}