/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the identitystore-2020-06-15.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.IdentityStore.Model;
namespace Amazon.IdentityStore
{
///
/// Interface for accessing IdentityStore
///
/// The Identity Store service used by AWS IAM Identity Center (successor to AWS Single
/// Sign-On) provides a single place to retrieve all of your identities (users and groups).
/// For more information, see the IAM
/// Identity Center User Guide.
///
/// <note> <p>Although AWS Single Sign-On was renamed, the <code>sso</code>
/// and <code>identitystore</code> API namespaces will continue to retain
/// their original name for backward compatibility purposes. For more information, see
/// <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM
/// Identity Center rename</a>.</p> </note> <p>This reference
/// guide describes the identity store operations that you can call programatically and
/// includes detailed information about data types and errors.</p>
///
public partial interface IAmazonIdentityStore : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IIdentityStorePaginatorFactory Paginators { get; }
#endif
#region CreateGroup
///
/// Creates a group within the specified identity store.
///
/// Container for the necessary parameters to execute the CreateGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateGroup service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// This request cannot be completed for one of the following reasons:
///
/// -
///
/// Performing the requested operation would violate an existing uniqueness claim in the
/// identity store. Resolve the conflict before retrying this request.
///
///
-
///
/// The requested resource was being concurrently modified by another request.
///
///
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// The request would cause the number of users or groups in the identity store to exceed
/// the maximum allowed.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for CreateGroup Operation
Task CreateGroupAsync(CreateGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateGroupMembership
///
/// Creates a relationship between a member and a group. The following identifiers must
/// be specified: GroupId, IdentityStoreId, and MemberId.
///
/// Container for the necessary parameters to execute the CreateGroupMembership service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateGroupMembership service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// This request cannot be completed for one of the following reasons:
///
/// -
///
/// Performing the requested operation would violate an existing uniqueness claim in the
/// identity store. Resolve the conflict before retrying this request.
///
///
-
///
/// The requested resource was being concurrently modified by another request.
///
///
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// The request would cause the number of users or groups in the identity store to exceed
/// the maximum allowed.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for CreateGroupMembership Operation
Task CreateGroupMembershipAsync(CreateGroupMembershipRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateUser
///
/// Creates a user within the specified identity store.
///
/// Container for the necessary parameters to execute the CreateUser service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateUser service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// This request cannot be completed for one of the following reasons:
///
/// -
///
/// Performing the requested operation would violate an existing uniqueness claim in the
/// identity store. Resolve the conflict before retrying this request.
///
///
-
///
/// The requested resource was being concurrently modified by another request.
///
///
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// The request would cause the number of users or groups in the identity store to exceed
/// the maximum allowed.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for CreateUser Operation
Task CreateUserAsync(CreateUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteGroup
///
/// Delete a group within an identity store given GroupId.
///
/// Container for the necessary parameters to execute the DeleteGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteGroup service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// This request cannot be completed for one of the following reasons:
///
/// -
///
/// Performing the requested operation would violate an existing uniqueness claim in the
/// identity store. Resolve the conflict before retrying this request.
///
///
-
///
/// The requested resource was being concurrently modified by another request.
///
///
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for DeleteGroup Operation
Task DeleteGroupAsync(DeleteGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteGroupMembership
///
/// Delete a membership within a group given MembershipId.
///
/// Container for the necessary parameters to execute the DeleteGroupMembership service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteGroupMembership service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// This request cannot be completed for one of the following reasons:
///
/// -
///
/// Performing the requested operation would violate an existing uniqueness claim in the
/// identity store. Resolve the conflict before retrying this request.
///
///
-
///
/// The requested resource was being concurrently modified by another request.
///
///
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for DeleteGroupMembership Operation
Task DeleteGroupMembershipAsync(DeleteGroupMembershipRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteUser
///
/// Deletes a user within an identity store given UserId.
///
/// Container for the necessary parameters to execute the DeleteUser service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteUser service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// This request cannot be completed for one of the following reasons:
///
/// -
///
/// Performing the requested operation would violate an existing uniqueness claim in the
/// identity store. Resolve the conflict before retrying this request.
///
///
-
///
/// The requested resource was being concurrently modified by another request.
///
///
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for DeleteUser Operation
Task DeleteUserAsync(DeleteUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeGroup
///
/// Retrieves the group metadata and attributes from GroupId in an identity
/// store.
///
/// Container for the necessary parameters to execute the DescribeGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeGroup service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for DescribeGroup Operation
Task DescribeGroupAsync(DescribeGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeGroupMembership
///
/// Retrieves membership metadata and attributes from MembershipId in an
/// identity store.
///
/// Container for the necessary parameters to execute the DescribeGroupMembership service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeGroupMembership service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for DescribeGroupMembership Operation
Task DescribeGroupMembershipAsync(DescribeGroupMembershipRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeUser
///
/// Retrieves the user metadata and attributes from the UserId in an identity
/// store.
///
/// Container for the necessary parameters to execute the DescribeUser service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeUser service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for DescribeUser Operation
Task DescribeUserAsync(DescribeUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetGroupId
///
/// Retrieves GroupId in an identity store.
///
/// Container for the necessary parameters to execute the GetGroupId service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetGroupId service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for GetGroupId Operation
Task GetGroupIdAsync(GetGroupIdRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetGroupMembershipId
///
/// Retrieves the MembershipId in an identity store.
///
/// Container for the necessary parameters to execute the GetGroupMembershipId service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetGroupMembershipId service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for GetGroupMembershipId Operation
Task GetGroupMembershipIdAsync(GetGroupMembershipIdRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetUserId
///
/// Retrieves the UserId in an identity store.
///
/// Container for the necessary parameters to execute the GetUserId service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetUserId service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for GetUserId Operation
Task GetUserIdAsync(GetUserIdRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region IsMemberInGroups
///
/// Checks the user's membership in all requested groups and returns if the member exists
/// in all queried groups.
///
/// Container for the necessary parameters to execute the IsMemberInGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the IsMemberInGroups service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for IsMemberInGroups Operation
Task IsMemberInGroupsAsync(IsMemberInGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListGroupMemberships
///
/// For the specified group in the specified identity store, returns the list of all GroupMembership
/// objects and returns results in paginated form.
///
/// Container for the necessary parameters to execute the ListGroupMemberships service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListGroupMemberships service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for ListGroupMemberships Operation
Task ListGroupMembershipsAsync(ListGroupMembershipsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListGroupMembershipsForMember
///
/// For the specified member in the specified identity store, returns the list of all
/// GroupMembership objects and returns results in paginated form.
///
/// Container for the necessary parameters to execute the ListGroupMembershipsForMember service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListGroupMembershipsForMember service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for ListGroupMembershipsForMember Operation
Task ListGroupMembershipsForMemberAsync(ListGroupMembershipsForMemberRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListGroups
///
/// Lists all groups in the identity store. Returns a paginated list of complete Group
/// objects. Filtering for a Group by the DisplayName attribute
/// is deprecated. Instead, use the GetGroupId API action.
///
/// Container for the necessary parameters to execute the ListGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListGroups service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for ListGroups Operation
Task ListGroupsAsync(ListGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListUsers
///
/// Lists all users in the identity store. Returns a paginated list of complete User
/// objects. Filtering for a User by the UserName attribute
/// is deprecated. Instead, use the GetUserId API action.
///
/// Container for the necessary parameters to execute the ListUsers service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListUsers service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for ListUsers Operation
Task ListUsersAsync(ListUsersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateGroup
///
/// For the specified group in the specified identity store, updates the group metadata
/// and attributes.
///
/// Container for the necessary parameters to execute the UpdateGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateGroup service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// This request cannot be completed for one of the following reasons:
///
/// -
///
/// Performing the requested operation would violate an existing uniqueness claim in the
/// identity store. Resolve the conflict before retrying this request.
///
///
-
///
/// The requested resource was being concurrently modified by another request.
///
///
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// The request would cause the number of users or groups in the identity store to exceed
/// the maximum allowed.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for UpdateGroup Operation
Task UpdateGroupAsync(UpdateGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateUser
///
/// For the specified user in the specified identity store, updates the user metadata
/// and attributes.
///
/// Container for the necessary parameters to execute the UpdateUser service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateUser service method, as returned by IdentityStore.
///
/// You do not have sufficient access to perform this action.
///
///
/// This request cannot be completed for one of the following reasons:
///
/// -
///
/// Performing the requested operation would violate an existing uniqueness claim in the
/// identity store. Resolve the conflict before retrying this request.
///
///
-
///
/// The requested resource was being concurrently modified by another request.
///
///
///
///
/// The request processing has failed because of an unknown error, exception or failure
/// with an internal server.
///
///
/// Indicates that a requested resource is not found.
///
///
/// The request would cause the number of users or groups in the identity store to exceed
/// the maximum allowed.
///
///
/// Indicates that the principal has crossed the throttling limits of the API operations.
///
///
/// The request failed because it contains a syntax error.
///
/// REST API Reference for UpdateUser Operation
Task UpdateUserAsync(UpdateUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}