SSOAdmin

public struct SSOAdmin

Client object for interacting with AWS SSOAdmin service.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the SSOAdmin 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


                    
                    
                    attachManagedPolicyToPermissionSet(_:)

Attaches an IAM managed policy ARN to a permission set.

Declaration

Swift

public func attachManagedPolicyToPermissionSet(_ input: AttachManagedPolicyToPermissionSetRequest) -> EventLoopFuture<AttachManagedPolicyToPermissionSetResponse>

createAccountAssignment(_:)
Assigns access to a principal for a specified AWS account using a specified permission set. The term principal here refers to a user or group that is defined in AWS SSO.
Declaration
Swift

public func createAccountAssignment(_ input: CreateAccountAssignmentRequest) -> EventLoopFuture<CreateAccountAssignmentResponse>


                    
                    
                    createPermissionSet(_:)

Creates a permission set within a specified SSO instance.

Declaration

Swift

public func createPermissionSet(_ input: CreatePermissionSetRequest) -> EventLoopFuture<CreatePermissionSetResponse>

deleteAccountAssignment(_:)
Deletes a principal’s access from a specified AWS account using a specified permission set.
Declaration
Swift

public func deleteAccountAssignment(_ input: DeleteAccountAssignmentRequest) -> EventLoopFuture<DeleteAccountAssignmentResponse>


                    
                    
                    deleteInlinePolicyFromPermissionSet(_:)

Deletes the inline policy from a specified permission set.

Declaration

Swift

public func deleteInlinePolicyFromPermissionSet(_ input: DeleteInlinePolicyFromPermissionSetRequest) -> EventLoopFuture<DeleteInlinePolicyFromPermissionSetResponse>


                    
                    
                    deletePermissionSet(_:)

Deletes the specified permission set.

Declaration

Swift

public func deletePermissionSet(_ input: DeletePermissionSetRequest) -> EventLoopFuture<DeletePermissionSetResponse>


                    
                    
                    describeAccountAssignmentCreationStatus(_:)

Describes the status of the assignment creation request.

Declaration

Swift

public func describeAccountAssignmentCreationStatus(_ input: DescribeAccountAssignmentCreationStatusRequest) -> EventLoopFuture<DescribeAccountAssignmentCreationStatusResponse>


                    
                    
                    describeAccountAssignmentDeletionStatus(_:)

Describes the status of the assignment deletion request.

Declaration

Swift

public func describeAccountAssignmentDeletionStatus(_ input: DescribeAccountAssignmentDeletionStatusRequest) -> EventLoopFuture<DescribeAccountAssignmentDeletionStatusResponse>


                    
                    
                    describePermissionSet(_:)

Gets the details of the permission set.

Declaration

Swift

public func describePermissionSet(_ input: DescribePermissionSetRequest) -> EventLoopFuture<DescribePermissionSetResponse>


                    
                    
                    describePermissionSetProvisioningStatus(_:)

Describes the status for the given permission set provisioning request.

Declaration

Swift

public func describePermissionSetProvisioningStatus(_ input: DescribePermissionSetProvisioningStatusRequest) -> EventLoopFuture<DescribePermissionSetProvisioningStatusResponse>


                    
                    
                    detachManagedPolicyFromPermissionSet(_:)

Detaches the attached IAM managed policy ARN from the specified permission set.

Declaration

Swift

public func detachManagedPolicyFromPermissionSet(_ input: DetachManagedPolicyFromPermissionSetRequest) -> EventLoopFuture<DetachManagedPolicyFromPermissionSetResponse>


                    
                    
                    getInlinePolicyForPermissionSet(_:)

Obtains the inline policy assigned to the permission set.

Declaration

Swift

public func getInlinePolicyForPermissionSet(_ input: GetInlinePolicyForPermissionSetRequest) -> EventLoopFuture<GetInlinePolicyForPermissionSetResponse>


                    
                    
                    listAccountAssignmentCreationStatus(_:)

Lists the status of the AWS account assignment creation requests for a specified SSO instance.

Declaration

Swift

public func listAccountAssignmentCreationStatus(_ input: ListAccountAssignmentCreationStatusRequest) -> EventLoopFuture<ListAccountAssignmentCreationStatusResponse>


                    
                    
                    listAccountAssignmentDeletionStatus(_:)

Lists the status of the AWS account assignment deletion requests for a specified SSO instance.

Declaration

Swift

public func listAccountAssignmentDeletionStatus(_ input: ListAccountAssignmentDeletionStatusRequest) -> EventLoopFuture<ListAccountAssignmentDeletionStatusResponse>


                    
                    
                    listAccountAssignments(_:)

Lists the assignee of the specified AWS account with the specified permission set.

Declaration

Swift

public func listAccountAssignments(_ input: ListAccountAssignmentsRequest) -> EventLoopFuture<ListAccountAssignmentsResponse>


                    
                    
                    listAccountsForProvisionedPermissionSet(_:)

Lists all the AWS accounts where the specified permission set is provisioned.

Declaration

Swift

public func listAccountsForProvisionedPermissionSet(_ input: ListAccountsForProvisionedPermissionSetRequest) -> EventLoopFuture<ListAccountsForProvisionedPermissionSetResponse>


                    
                    
                    listInstances(_:)

Lists the SSO instances that the caller has access to.

Declaration

Swift

public func listInstances(_ input: ListInstancesRequest) -> EventLoopFuture<ListInstancesResponse>


                    
                    
                    listManagedPoliciesInPermissionSet(_:)

Lists the IAM managed policy that is attached to a specified permission set.

Declaration

Swift

public func listManagedPoliciesInPermissionSet(_ input: ListManagedPoliciesInPermissionSetRequest) -> EventLoopFuture<ListManagedPoliciesInPermissionSetResponse>


                    
                    
                    listPermissionSetProvisioningStatus(_:)

Lists the status of the permission set provisioning requests for a specified SSO instance.

Declaration

Swift

public func listPermissionSetProvisioningStatus(_ input: ListPermissionSetProvisioningStatusRequest) -> EventLoopFuture<ListPermissionSetProvisioningStatusResponse>


                    
                    
                    listPermissionSets(_:)

Lists the PermissionSets in an SSO instance.

Declaration

Swift

public func listPermissionSets(_ input: ListPermissionSetsRequest) -> EventLoopFuture<ListPermissionSetsResponse>


                    
                    
                    listPermissionSetsProvisionedToAccount(_:)

Lists all the permission sets that are provisioned to a specified AWS account.

Declaration

Swift

public func listPermissionSetsProvisionedToAccount(_ input: ListPermissionSetsProvisionedToAccountRequest) -> EventLoopFuture<ListPermissionSetsProvisionedToAccountResponse>


                    
                    
                    listTagsForResource(_:)

Lists the tags that are attached to a specified resource.

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>


                    
                    
                    provisionPermissionSet(_:)

The process by which a specified permission set is provisioned to the specified target.

Declaration

Swift

public func provisionPermissionSet(_ input: ProvisionPermissionSetRequest) -> EventLoopFuture<ProvisionPermissionSetResponse>


                    
                    
                    putInlinePolicyToPermissionSet(_:)

Attaches an IAM inline policy to a permission set.

Declaration

Swift

public func putInlinePolicyToPermissionSet(_ input: PutInlinePolicyToPermissionSetRequest) -> EventLoopFuture<PutInlinePolicyToPermissionSetResponse>


                    
                    
                    tagResource(_:)

Associates a set of tags with a specified resource.

Declaration

Swift

public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>


                    
                    
                    untagResource(_:)

Disassociates a set of tags from a specified resource.

Declaration

Swift

public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>


                    
                    
                    updatePermissionSet(_:)

Updates an existing permission set.

Declaration

Swift

public func updatePermissionSet(_ input: UpdatePermissionSetRequest) -> EventLoopFuture<UpdatePermissionSetResponse>

Paginators


                    
                    
                    listAccountAssignmentCreationStatusPaginator(_:onPage:)

Lists the status of the AWS account assignment creation requests for a specified SSO instance.

Declaration

Swift

public func listAccountAssignmentCreationStatusPaginator(_ input: ListAccountAssignmentCreationStatusRequest, onPage: @escaping (ListAccountAssignmentCreationStatusResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listAccountAssignmentDeletionStatusPaginator(_:onPage:)

Lists the status of the AWS account assignment deletion requests for a specified SSO instance.

Declaration

Swift

public func listAccountAssignmentDeletionStatusPaginator(_ input: ListAccountAssignmentDeletionStatusRequest, onPage: @escaping (ListAccountAssignmentDeletionStatusResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listAccountAssignmentsPaginator(_:onPage:)

Lists the assignee of the specified AWS account with the specified permission set.

Declaration

Swift

public func listAccountAssignmentsPaginator(_ input: ListAccountAssignmentsRequest, onPage: @escaping (ListAccountAssignmentsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listAccountsForProvisionedPermissionSetPaginator(_:onPage:)

Lists all the AWS accounts where the specified permission set is provisioned.

Declaration

Swift

public func listAccountsForProvisionedPermissionSetPaginator(_ input: ListAccountsForProvisionedPermissionSetRequest, onPage: @escaping (ListAccountsForProvisionedPermissionSetResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listInstancesPaginator(_:onPage:)

Lists the SSO instances that the caller has access to.

Declaration

Swift

public func listInstancesPaginator(_ input: ListInstancesRequest, onPage: @escaping (ListInstancesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listManagedPoliciesInPermissionSetPaginator(_:onPage:)

Lists the IAM managed policy that is attached to a specified permission set.

Declaration

Swift

public func listManagedPoliciesInPermissionSetPaginator(_ input: ListManagedPoliciesInPermissionSetRequest, onPage: @escaping (ListManagedPoliciesInPermissionSetResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listPermissionSetProvisioningStatusPaginator(_:onPage:)

Lists the status of the permission set provisioning requests for a specified SSO instance.

Declaration

Swift

public func listPermissionSetProvisioningStatusPaginator(_ input: ListPermissionSetProvisioningStatusRequest, onPage: @escaping (ListPermissionSetProvisioningStatusResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listPermissionSetsPaginator(_:onPage:)

Lists the PermissionSets in an SSO instance.

Declaration

Swift

public func listPermissionSetsPaginator(_ input: ListPermissionSetsRequest, onPage: @escaping (ListPermissionSetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listPermissionSetsProvisionedToAccountPaginator(_:onPage:)

Lists all the permission sets that are provisioned to a specified AWS account.

Declaration

Swift

public func listPermissionSetsProvisionedToAccountPaginator(_ input: ListPermissionSetsProvisionedToAccountRequest, onPage: @escaping (ListPermissionSetsProvisionedToAccountResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listTagsForResourcePaginator(_:onPage:)

Lists the tags that are attached to a specified resource.

Declaration

Swift

public func listTagsForResourcePaginator(_ input: ListTagsForResourceRequest, onPage: @escaping (ListTagsForResourceResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListAccountAssignmentCreationStatusRequest

Undocumented

Declaration

Swift

public struct ListAccountAssignmentCreationStatusRequest : AWSShape

extension SSOAdmin.ListAccountAssignmentCreationStatusRequest: AWSPaginateStringToken


                    
                    
                    ListAccountAssignmentDeletionStatusRequest

Undocumented

Declaration

Swift

public struct ListAccountAssignmentDeletionStatusRequest : AWSShape

extension SSOAdmin.ListAccountAssignmentDeletionStatusRequest: AWSPaginateStringToken


                    
                    
                    ListAccountAssignmentsRequest

Undocumented

Declaration

Swift

public struct ListAccountAssignmentsRequest : AWSShape

extension SSOAdmin.ListAccountAssignmentsRequest: AWSPaginateStringToken


                    
                    
                    ListAccountsForProvisionedPermissionSetRequest

Undocumented

Declaration

Swift

public struct ListAccountsForProvisionedPermissionSetRequest : AWSShape

extension SSOAdmin.ListAccountsForProvisionedPermissionSetRequest: AWSPaginateStringToken


                    
                    
                    ListInstancesRequest

Undocumented

Declaration

Swift

public struct ListInstancesRequest : AWSShape

extension SSOAdmin.ListInstancesRequest: AWSPaginateStringToken


                    
                    
                    ListManagedPoliciesInPermissionSetRequest

Undocumented

Declaration

Swift

public struct ListManagedPoliciesInPermissionSetRequest : AWSShape

extension SSOAdmin.ListManagedPoliciesInPermissionSetRequest: AWSPaginateStringToken


                    
                    
                    ListPermissionSetProvisioningStatusRequest

Undocumented

Declaration

Swift

public struct ListPermissionSetProvisioningStatusRequest : AWSShape

extension SSOAdmin.ListPermissionSetProvisioningStatusRequest: AWSPaginateStringToken


                    
                    
                    ListPermissionSetsRequest

Undocumented

Declaration

Swift

public struct ListPermissionSetsRequest : AWSShape

extension SSOAdmin.ListPermissionSetsRequest: AWSPaginateStringToken


                    
                    
                    ListPermissionSetsProvisionedToAccountRequest

Undocumented

Declaration

Swift

public struct ListPermissionSetsProvisionedToAccountRequest : AWSShape

extension SSOAdmin.ListPermissionSetsProvisionedToAccountRequest: AWSPaginateStringToken


                    
                    
                    ListTagsForResourceRequest

Undocumented

Declaration

Swift

public struct ListTagsForResourceRequest : AWSShape

extension SSOAdmin.ListTagsForResourceRequest: AWSPaginateStringToken

AccountAssignment
Undocumented
See more
Declaration
Swift

public struct AccountAssignment : AWSShape
AccountAssignmentOperationStatus
Undocumented
See more
Declaration
Swift

public struct AccountAssignmentOperationStatus : AWSShape
AccountAssignmentOperationStatusMetadata
Undocumented
See more
Declaration
Swift

public struct AccountAssignmentOperationStatusMetadata : AWSShape
AttachManagedPolicyToPermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct AttachManagedPolicyToPermissionSetRequest : AWSShape
AttachManagedPolicyToPermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct AttachManagedPolicyToPermissionSetResponse : AWSShape
AttachedManagedPolicy
Undocumented
See more
Declaration
Swift

public struct AttachedManagedPolicy : AWSShape
CreateAccountAssignmentRequest
Undocumented
See more
Declaration
Swift

public struct CreateAccountAssignmentRequest : AWSShape
CreateAccountAssignmentResponse
Undocumented
See more
Declaration
Swift

public struct CreateAccountAssignmentResponse : AWSShape
CreatePermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct CreatePermissionSetRequest : AWSShape
CreatePermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct CreatePermissionSetResponse : AWSShape
DeleteAccountAssignmentRequest
Undocumented
See more
Declaration
Swift

public struct DeleteAccountAssignmentRequest : AWSShape
DeleteAccountAssignmentResponse
Undocumented
See more
Declaration
Swift

public struct DeleteAccountAssignmentResponse : AWSShape
DeleteInlinePolicyFromPermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct DeleteInlinePolicyFromPermissionSetRequest : AWSShape
DeleteInlinePolicyFromPermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct DeleteInlinePolicyFromPermissionSetResponse : AWSShape
DeletePermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct DeletePermissionSetRequest : AWSShape
DeletePermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct DeletePermissionSetResponse : AWSShape
DescribeAccountAssignmentCreationStatusRequest
Undocumented
See more
Declaration
Swift

public struct DescribeAccountAssignmentCreationStatusRequest : AWSShape
DescribeAccountAssignmentCreationStatusResponse
Undocumented
See more
Declaration
Swift

public struct DescribeAccountAssignmentCreationStatusResponse : AWSShape
DescribeAccountAssignmentDeletionStatusRequest
Undocumented
See more
Declaration
Swift

public struct DescribeAccountAssignmentDeletionStatusRequest : AWSShape
DescribeAccountAssignmentDeletionStatusResponse
Undocumented
See more
Declaration
Swift

public struct DescribeAccountAssignmentDeletionStatusResponse : AWSShape
DescribePermissionSetProvisioningStatusRequest
Undocumented
See more
Declaration
Swift

public struct DescribePermissionSetProvisioningStatusRequest : AWSShape
DescribePermissionSetProvisioningStatusResponse
Undocumented
See more
Declaration
Swift

public struct DescribePermissionSetProvisioningStatusResponse : AWSShape
DescribePermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct DescribePermissionSetRequest : AWSShape
DescribePermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct DescribePermissionSetResponse : AWSShape
DetachManagedPolicyFromPermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct DetachManagedPolicyFromPermissionSetRequest : AWSShape
DetachManagedPolicyFromPermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct DetachManagedPolicyFromPermissionSetResponse : AWSShape
GetInlinePolicyForPermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct GetInlinePolicyForPermissionSetRequest : AWSShape
GetInlinePolicyForPermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct GetInlinePolicyForPermissionSetResponse : AWSShape
InstanceMetadata
Undocumented
See more
Declaration
Swift

public struct InstanceMetadata : AWSShape
ListAccountAssignmentCreationStatusResponse
Undocumented
See more
Declaration
Swift

public struct ListAccountAssignmentCreationStatusResponse : AWSShape
ListAccountAssignmentDeletionStatusResponse
Undocumented
See more
Declaration
Swift

public struct ListAccountAssignmentDeletionStatusResponse : AWSShape
ListAccountAssignmentsResponse
Undocumented
See more
Declaration
Swift

public struct ListAccountAssignmentsResponse : AWSShape
ListAccountsForProvisionedPermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct ListAccountsForProvisionedPermissionSetResponse : AWSShape
ListInstancesResponse
Undocumented
See more
Declaration
Swift

public struct ListInstancesResponse : AWSShape
ListManagedPoliciesInPermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct ListManagedPoliciesInPermissionSetResponse : AWSShape
ListPermissionSetProvisioningStatusResponse
Undocumented
See more
Declaration
Swift

public struct ListPermissionSetProvisioningStatusResponse : AWSShape
ListPermissionSetsProvisionedToAccountResponse
Undocumented
See more
Declaration
Swift

public struct ListPermissionSetsProvisionedToAccountResponse : AWSShape
ListPermissionSetsResponse
Undocumented
See more
Declaration
Swift

public struct ListPermissionSetsResponse : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
OperationStatusFilter
Undocumented
See more
Declaration
Swift

public struct OperationStatusFilter : AWSShape
PermissionSet
Undocumented
See more
Declaration
Swift

public struct PermissionSet : AWSShape
PermissionSetProvisioningStatus
Undocumented
See more
Declaration
Swift

public struct PermissionSetProvisioningStatus : AWSShape
PermissionSetProvisioningStatusMetadata
Undocumented
See more
Declaration
Swift

public struct PermissionSetProvisioningStatusMetadata : AWSShape
ProvisionPermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct ProvisionPermissionSetRequest : AWSShape
ProvisionPermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct ProvisionPermissionSetResponse : AWSShape
PutInlinePolicyToPermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct PutInlinePolicyToPermissionSetRequest : AWSShape
PutInlinePolicyToPermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct PutInlinePolicyToPermissionSetResponse : AWSShape
Tag
Undocumented
See more
Declaration
Swift

public struct Tag : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
TagResourceResponse
Undocumented
See more
Declaration
Swift

public struct TagResourceResponse : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UntagResourceResponse
Undocumented
See more
Declaration
Swift

public struct UntagResourceResponse : AWSShape
UpdatePermissionSetRequest
Undocumented
See more
Declaration
Swift

public struct UpdatePermissionSetRequest : AWSShape
UpdatePermissionSetResponse
Undocumented
See more
Declaration
Swift

public struct UpdatePermissionSetResponse : AWSShape

Enums


                    
                    
                    PrincipalType

Undocumented

Declaration

Swift

public enum PrincipalType : String, CustomStringConvertible, Codable


                    
                    
                    ProvisionTargetType

Undocumented

Declaration

Swift

public enum ProvisionTargetType : String, CustomStringConvertible, Codable


                    
                    
                    ProvisioningStatus

Undocumented

Declaration

Swift

public enum ProvisioningStatus : String, CustomStringConvertible, Codable


                    
                    
                    StatusValues

Undocumented

Declaration

Swift

public enum StatusValues : String, CustomStringConvertible, Codable


                    
                    
                    TargetType

Undocumented

Declaration

Swift

public enum TargetType : String, CustomStringConvertible, Codable