IdentityStore

Service object for interacting with AWS IdentityStore service.

public struct IdentityStore: AWSService

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.

Inheritance

AWSService

Initializers

`init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)`

Initialize the IdentityStore client

public init(
        client: AWSClient,
        region: SotoCore.Region? = nil,
        partition: AWSPartition = .aws,
        endpoint: String? = nil,
        timeout: TimeAmount? = nil,
        byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
        options: AWSServiceConfig.Options = []
    )

Parameters

client: AWSClient used to process requests
region: Region of server you want to communicate with. This will override the partition parameter.
partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
endpoint: Custom endpoint URL to use instead of standard AWS servers
timeout: Timeout value for HTTP requests

`init(from:patch:)`

Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options). You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options) instead.

public init(from: IdentityStore, patch: AWSServiceConfig.Patch)

Properties

`client`

Client used for communication with AWS

public let client: AWSClient

`config`

Service configuration

public let config: AWSServiceConfig

Methods

`describeGroup(_:logger:on:)`

public func describeGroup(_ input: DescribeGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeGroupResponse>

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

`describeUser(_:logger:on:)`

public func describeUser(_ input: DescribeUserRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeUserResponse>

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

`listGroups(_:logger:on:)`

public func listGroups(_ input: ListGroupsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListGroupsResponse>

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.

`listUsers(_:logger:on:)`

public func listUsers(_ input: ListUsersRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListUsersResponse>

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.

`listGroupsPaginator(_:logger:on:)`

compiler(>=5.5.2) && canImport(_Concurrency)

public func listGroupsPaginator(
        _ input: ListGroupsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil
    ) -> AWSClient.PaginatorSequence<ListGroupsRequest, ListGroupsResponse>

Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on

`listUsersPaginator(_:logger:on:)`

compiler(>=5.5.2) && canImport(_Concurrency)

public func listUsersPaginator(
        _ input: ListUsersRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil
    ) -> AWSClient.PaginatorSequence<ListUsersRequest, ListUsersResponse>

Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on

`listGroupsPaginator(_:_:logger:on:onPage:)`

Provide paginated results to closure onPage for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result.

public func listGroupsPaginator<Result>(
        _ input: ListGroupsRequest,
        _ initialValue: Result,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (Result, ListGroupsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
    ) -> EventLoopFuture<Result>

Parameters:

input: Input for request

initialValue: The value to use as the initial accumulating value. initialValue is passed to onPage the first time it is called.

logger: Logger used flot logging

eventLoop: EventLoop to run this process on

onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.

`listGroupsPaginator(_:logger:on:onPage:)`

Provide paginated results to closure onPage.

public func listGroupsPaginator(
        _ input: ListGroupsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (ListGroupsResponse, EventLoop) -> EventLoopFuture<Bool>
    ) -> EventLoopFuture<Void>

Parameters

input: Input for request
logger: Logger used flot logging
eventLoop: EventLoop to run this process on
onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.

`listUsersPaginator(_:_:logger:on:onPage:)`

Provide paginated results to closure onPage for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result.

public func listUsersPaginator<Result>(
        _ input: ListUsersRequest,
        _ initialValue: Result,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (Result, ListUsersResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
    ) -> EventLoopFuture<Result>

Parameters:

input: Input for request

initialValue: The value to use as the initial accumulating value. initialValue is passed to onPage the first time it is called.

logger: Logger used flot logging

eventLoop: EventLoop to run this process on

onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.

`listUsersPaginator(_:logger:on:onPage:)`

Provide paginated results to closure onPage.

public func listUsersPaginator(
        _ input: ListUsersRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (ListUsersResponse, EventLoop) -> EventLoopFuture<Bool>
    ) -> EventLoopFuture<Void>

Parameters

input: Input for request
logger: Logger used flot logging
eventLoop: EventLoop to run this process on
onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.