IdentityStore

public struct IdentityStore

Client object for interacting with AWS IdentityStore service.

Member variables

Initialization

  • Initialize the IdentityStore client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Retrieves the group metadata and attributes from GroupId in an identity store.

    Declaration

    Swift

    public func describeGroup(_ input: DescribeGroupRequest) -> EventLoopFuture<DescribeGroupResponse>

  • Retrieves the user metadata and attributes from UserId in an identity store.

    Declaration

    Swift

    public func describeUser(_ input: DescribeUserRequest) -> EventLoopFuture<DescribeUserResponse>

  • 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.

    Declaration

    Swift

    public func listGroups(_ input: ListGroupsRequest) -> EventLoopFuture<ListGroupsResponse>

  • 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.

    Declaration

    Swift

    public func listUsers(_ input: ListUsersRequest) -> EventLoopFuture<ListUsersResponse>

Paginators

  • 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.

    Declaration

    Swift

    public func listGroupsPaginator(_ input: ListGroupsRequest, onPage: @escaping (ListGroupsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func listUsersPaginator(_ input: ListUsersRequest, onPage: @escaping (ListUsersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes