RAM

import { RAM } from "https://aws-api.deno.dev/v0.3/services/ram.ts?docs=full";

class RAM {

constructor(apiFactory: client.ApiFactory);

async acceptResourceShareInvitation(params: AcceptResourceShareInvitationRequest, opts?: client.RequestOptions): Promise<AcceptResourceShareInvitationResponse>;

async associateResourceShare(params: AssociateResourceShareRequest, opts?: client.RequestOptions): Promise<AssociateResourceShareResponse>;

async associateResourceSharePermission(params: AssociateResourceSharePermissionRequest, opts?: client.RequestOptions): Promise<AssociateResourceSharePermissionResponse>;

async createResourceShare(params: CreateResourceShareRequest, opts?: client.RequestOptions): Promise<CreateResourceShareResponse>;

async deleteResourceShare(params: DeleteResourceShareRequest, opts?: client.RequestOptions): Promise<DeleteResourceShareResponse>;

async disassociateResourceShare(params: DisassociateResourceShareRequest, opts?: client.RequestOptions): Promise<DisassociateResourceShareResponse>;

async disassociateResourceSharePermission(params: DisassociateResourceSharePermissionRequest, opts?: client.RequestOptions): Promise<DisassociateResourceSharePermissionResponse>;

async enableSharingWithAwsOrganization(opts?: client.RequestOptions): Promise<EnableSharingWithAwsOrganizationResponse>;

async getPermission(params: GetPermissionRequest, opts?: client.RequestOptions): Promise<GetPermissionResponse>;

async getResourcePolicies(params: GetResourcePoliciesRequest, opts?: client.RequestOptions): Promise<GetResourcePoliciesResponse>;

async getResourceShareAssociations(params: GetResourceShareAssociationsRequest, opts?: client.RequestOptions): Promise<GetResourceShareAssociationsResponse>;

async getResourceShareInvitations(params?: GetResourceShareInvitationsRequest, opts?: client.RequestOptions): Promise<GetResourceShareInvitationsResponse>;

async getResourceShares(params: GetResourceSharesRequest, opts?: client.RequestOptions): Promise<GetResourceSharesResponse>;

async listPendingInvitationResources(params: ListPendingInvitationResourcesRequest, opts?: client.RequestOptions): Promise<ListPendingInvitationResourcesResponse>;

async listPermissions(params?: ListPermissionsRequest, opts?: client.RequestOptions): Promise<ListPermissionsResponse>;

async listPermissionVersions(params: ListPermissionVersionsRequest, opts?: client.RequestOptions): Promise<ListPermissionVersionsResponse>;

async listPrincipals(params: ListPrincipalsRequest, opts?: client.RequestOptions): Promise<ListPrincipalsResponse>;

async listResources(params: ListResourcesRequest, opts?: client.RequestOptions): Promise<ListResourcesResponse>;

async listResourceSharePermissions(params: ListResourceSharePermissionsRequest, opts?: client.RequestOptions): Promise<ListResourceSharePermissionsResponse>;

async listResourceTypes(params?: ListResourceTypesRequest, opts?: client.RequestOptions): Promise<ListResourceTypesResponse>;

async promoteResourceShareCreatedFromPolicy(params: PromoteResourceShareCreatedFromPolicyRequest, opts?: client.RequestOptions): Promise<PromoteResourceShareCreatedFromPolicyResponse>;

async rejectResourceShareInvitation(params: RejectResourceShareInvitationRequest, opts?: client.RequestOptions): Promise<RejectResourceShareInvitationResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateResourceShare(params: UpdateResourceShareRequest, opts?: client.RequestOptions): Promise<UpdateResourceShareResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new RAM(apiFactory: client.ApiFactory)

[src]

§Methods

acceptResourceShareInvitation(params: AcceptResourceShareInvitationRequest, opts?: client.RequestOptions): Promise<AcceptResourceShareInvitationResponse>

[src]

Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.

associateResourceShare(params: AssociateResourceShareRequest, opts?: client.RequestOptions): Promise<AssociateResourceShareResponse>

[src]

Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.

associateResourceSharePermission(params: AssociateResourceSharePermissionRequest, opts?: client.RequestOptions): Promise<AssociateResourceSharePermissionResponse>

[src]

Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.

createResourceShare(params: CreateResourceShareRequest, opts?: client.RequestOptions): Promise<CreateResourceShareResponse>

[src]

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Note: Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

deleteResourceShare(params: DeleteResourceShareRequest, opts?: client.RequestOptions): Promise<DeleteResourceShareResponse>

[src]

Deletes the specified resource share. This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources outside of the Amazon Web Services account that created them.

disassociateResourceShare(params: DisassociateResourceShareRequest, opts?: client.RequestOptions): Promise<DisassociateResourceShareResponse>

[src]

Disassociates the specified principals or resources from the specified resource share.

disassociateResourceSharePermission(params: DisassociateResourceSharePermissionRequest, opts?: client.RequestOptions): Promise<DisassociateResourceSharePermissionResponse>

[src]

Disassociates an RAM permission from a resource share. Permission changes take effect immediately. You can remove a RAM permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.

enableSharingWithAwsOrganization(opts?: client.RequestOptions): Promise<EnableSharingWithAwsOrganizationResponse>

[src]

Enables resource sharing within your organization in Organizations. Calling this operation enables RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in an organization by specifying the organization's ID, or all of the accounts in an organizational unit (OU) by specifying the OU's ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM users and roles.

You must call this operation from an IAM user or role in the organization's management account.

getPermission(params: GetPermissionRequest, opts?: client.RequestOptions): Promise<GetPermissionResponse>

[src]

Gets the contents of an RAM permission in JSON format.

getResourcePolicies(params: GetResourcePoliciesRequest, opts?: client.RequestOptions): Promise<GetResourcePoliciesResponse>

[src]

Retrieves the resource policies for the specified resources that you own and have shared.

getResourceShareAssociations(params: GetResourceShareAssociationsRequest, opts?: client.RequestOptions): Promise<GetResourceShareAssociationsResponse>

[src]

Retrieves the resource and principal associations for resource shares that you own.

getResourceShareInvitations(params?: GetResourceShareInvitationsRequest, opts?: client.RequestOptions): Promise<GetResourceShareInvitationsResponse>

[src]

Retrieves details about invitations that you have received for resource shares.

getResourceShares(params: GetResourceSharesRequest, opts?: client.RequestOptions): Promise<GetResourceSharesResponse>

[src]

Retrieves details about the resource shares that you own or that are shared with you.

listPendingInvitationResources(params: ListPendingInvitationResourcesRequest, opts?: client.RequestOptions): Promise<ListPendingInvitationResourcesResponse>

[src]

Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.

listPermissions(params?: ListPermissionsRequest, opts?: client.RequestOptions): Promise<ListPermissionsResponse>

[src]

Retrieves a list of available RAM permissions that you can use for the supported resource types.

listPermissionVersions(params: ListPermissionVersionsRequest, opts?: client.RequestOptions): Promise<ListPermissionVersionsResponse>

[src]

Lists the available versions of the specified RAM permission.

listPrincipals(params: ListPrincipalsRequest, opts?: client.RequestOptions): Promise<ListPrincipalsResponse>

[src]

Lists the principals that you are sharing resources with or that are sharing resources with you.

listResources(params: ListResourcesRequest, opts?: client.RequestOptions): Promise<ListResourcesResponse>

[src]

Lists the resources that you added to a resource shares or the resources that are shared with you.

listResourceSharePermissions(params: ListResourceSharePermissionsRequest, opts?: client.RequestOptions): Promise<ListResourceSharePermissionsResponse>

[src]

Lists the RAM permissions that are associated with a resource share.

listResourceTypes(params?: ListResourceTypesRequest, opts?: client.RequestOptions): Promise<ListResourceTypesResponse>

[src]

Lists the resource types that can be shared by RAM.

promoteResourceShareCreatedFromPolicy(params: PromoteResourceShareCreatedFromPolicyRequest, opts?: client.RequestOptions): Promise<PromoteResourceShareCreatedFromPolicyResponse>

[src]

When you attach a resource-based permission policy to a resource, it automatically creates a resource share. However, resource shares created this way are visible only to the resource share owner, and the resource share can't be modified in RAM.

You can use this operation to promote the resource share to a full RAM resource share. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.

rejectResourceShareInvitation(params: RejectResourceShareInvitationRequest, opts?: client.RequestOptions): Promise<RejectResourceShareInvitationResponse>

[src]

Rejects an invitation to a resource share from another Amazon Web Services account.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds the specified tag keys and values to the specified resource share. The tags are attached only to the resource share, not to the resources that are in the resource share.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the specified tag key and value pairs from the specified resource share.

updateResourceShare(params: UpdateResourceShareRequest, opts?: client.RequestOptions): Promise<UpdateResourceShareResponse>

[src]

Modifies some of the properties of the specified resource share.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]