RAM
public struct RAM
Client object for interacting with AWS RAM service.
Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resources associated with the resource share. The following principals are supported: AWS accounts, organizational units (OU) from AWS Organizations, and organizations from AWS Organizations. For more information, see the AWS Resource Access Manager User Guide.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the RAM 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.
-
Accepts an invitation to a resource share from another AWS account.
Declaration
Swift
public func acceptResourceShareInvitation(_ input: AcceptResourceShareInvitationRequest) -> EventLoopFuture<AcceptResourceShareInvitationResponse>
-
Associates the specified resource share with the specified principals and resources.
Declaration
Swift
public func associateResourceShare(_ input: AssociateResourceShareRequest) -> EventLoopFuture<AssociateResourceShareResponse>
-
Associates a permission with a resource share.
Declaration
Swift
public func associateResourceSharePermission(_ input: AssociateResourceSharePermissionRequest) -> EventLoopFuture<AssociateResourceSharePermissionResponse>
-
Creates a resource share.
Declaration
Swift
public func createResourceShare(_ input: CreateResourceShareRequest) -> EventLoopFuture<CreateResourceShareResponse>
-
Deletes the specified resource share.
Declaration
Swift
public func deleteResourceShare(_ input: DeleteResourceShareRequest) -> EventLoopFuture<DeleteResourceShareResponse>
-
Disassociates the specified principals or resources from the specified resource share.
Declaration
Swift
public func disassociateResourceShare(_ input: DisassociateResourceShareRequest) -> EventLoopFuture<DisassociateResourceShareResponse>
-
Disassociates an AWS RAM permission from a resource share.
Declaration
Swift
public func disassociateResourceSharePermission(_ input: DisassociateResourceSharePermissionRequest) -> EventLoopFuture<DisassociateResourceSharePermissionResponse>
-
Enables resource sharing within your AWS Organization. The caller must be the master account for the AWS Organization.
Declaration
Swift
public func enableSharingWithAwsOrganization(_ input: EnableSharingWithAwsOrganizationRequest) -> EventLoopFuture<EnableSharingWithAwsOrganizationResponse>
-
Gets the contents of an AWS RAM permission in JSON format.
Declaration
Swift
public func getPermission(_ input: GetPermissionRequest) -> EventLoopFuture<GetPermissionResponse>
-
Gets the policies for the specified resources that you own and have shared.
Declaration
Swift
public func getResourcePolicies(_ input: GetResourcePoliciesRequest) -> EventLoopFuture<GetResourcePoliciesResponse>
-
Gets the resources or principals for the resource shares that you own.
Declaration
Swift
public func getResourceShareAssociations(_ input: GetResourceShareAssociationsRequest) -> EventLoopFuture<GetResourceShareAssociationsResponse>
-
Gets the invitations for resource sharing that you’ve received.
Declaration
Swift
public func getResourceShareInvitations(_ input: GetResourceShareInvitationsRequest) -> EventLoopFuture<GetResourceShareInvitationsResponse>
-
Gets the resource shares that you own or the resource shares that are shared with you.
Declaration
Swift
public func getResourceShares(_ input: GetResourceSharesRequest) -> EventLoopFuture<GetResourceSharesResponse>
-
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
Declaration
Swift
public func listPendingInvitationResources(_ input: ListPendingInvitationResourcesRequest) -> EventLoopFuture<ListPendingInvitationResourcesResponse>
-
Lists the AWS RAM permissions.
Declaration
Swift
public func listPermissions(_ input: ListPermissionsRequest) -> EventLoopFuture<ListPermissionsResponse>
-
Lists the principals that you have shared resources with or that have shared resources with you.
Declaration
Swift
public func listPrincipals(_ input: ListPrincipalsRequest) -> EventLoopFuture<ListPrincipalsResponse>
-
Lists the AWS RAM permissions that are associated with a resource share.
Declaration
Swift
public func listResourceSharePermissions(_ input: ListResourceSharePermissionsRequest) -> EventLoopFuture<ListResourceSharePermissionsResponse>
-
Lists the shareable resource types supported by AWS RAM.
Declaration
Swift
public func listResourceTypes(_ input: ListResourceTypesRequest) -> EventLoopFuture<ListResourceTypesResponse>
-
Lists the resources that you added to a resource shares or the resources that are shared with you.
Declaration
Swift
public func listResources(_ input: ListResourcesRequest) -> EventLoopFuture<ListResourcesResponse>
-
Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM. Use this API action to promote the resource share. When you promote the resource share, it becomes: Visible to all principals that it is shared with. Modifiable in AWS RAM.
Declaration
Swift
public func promoteResourceShareCreatedFromPolicy(_ input: PromoteResourceShareCreatedFromPolicyRequest) -> EventLoopFuture<PromoteResourceShareCreatedFromPolicyResponse>
-
Rejects an invitation to a resource share from another AWS account.
Declaration
Swift
public func rejectResourceShareInvitation(_ input: RejectResourceShareInvitationRequest) -> EventLoopFuture<RejectResourceShareInvitationResponse>
-
Adds the specified tags to the specified resource share that you own.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>
-
Removes the specified tags from the specified resource share that you own.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>
-
Updates the specified resource share that you own.
Declaration
Swift
public func updateResourceShare(_ input: UpdateResourceShareRequest) -> EventLoopFuture<UpdateResourceShareResponse>
-
Gets the policies for the specified resources that you own and have shared.
Declaration
Swift
public func getResourcePoliciesPaginator(_ input: GetResourcePoliciesRequest, onPage: @escaping (GetResourcePoliciesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets the resources or principals for the resource shares that you own.
Declaration
Swift
public func getResourceShareAssociationsPaginator(_ input: GetResourceShareAssociationsRequest, onPage: @escaping (GetResourceShareAssociationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets the invitations for resource sharing that you’ve received.
Declaration
Swift
public func getResourceShareInvitationsPaginator(_ input: GetResourceShareInvitationsRequest, onPage: @escaping (GetResourceShareInvitationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets the resource shares that you own or the resource shares that are shared with you.
Declaration
Swift
public func getResourceSharesPaginator(_ input: GetResourceSharesRequest, onPage: @escaping (GetResourceSharesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
Declaration
Swift
public func listPendingInvitationResourcesPaginator(_ input: ListPendingInvitationResourcesRequest, onPage: @escaping (ListPendingInvitationResourcesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the principals that you have shared resources with or that have shared resources with you.
Declaration
Swift
public func listPrincipalsPaginator(_ input: ListPrincipalsRequest, onPage: @escaping (ListPrincipalsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the resources that you added to a resource shares or the resources that are shared with you.
Declaration
Swift
public func listResourcesPaginator(_ input: ListResourcesRequest, onPage: @escaping (ListResourcesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct GetResourcePoliciesRequest : AWSShape
extension RAM.GetResourcePoliciesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetResourceShareAssociationsRequest : AWSShape
extension RAM.GetResourceShareAssociationsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetResourceShareInvitationsRequest : AWSShape
extension RAM.GetResourceShareInvitationsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetResourceSharesRequest : AWSShape
extension RAM.GetResourceSharesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListPendingInvitationResourcesRequest : AWSShape
extension RAM.ListPendingInvitationResourcesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListPrincipalsRequest : AWSShape
extension RAM.ListPrincipalsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListResourcesRequest : AWSShape
extension RAM.ListResourcesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum ResourceOwner : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ResourceShareAssociationStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ResourceShareAssociationType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ResourceShareFeatureSet : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ResourceShareInvitationStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ResourceShareStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ResourceStatus : String, CustomStringConvertible, Codable