AbstractAWSRAM (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ram.AbstractAWSRAM

All Implemented Interfaces:

AWSRAM

Direct Known Subclasses:

AbstractAWSRAMAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSRAM
extends Object
implements AWSRAM
```
Abstract implementation of AWSRAM. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.ram.AWSRAM
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcceptResourceShareInvitationResult`	`acceptResourceShareInvitation(AcceptResourceShareInvitationRequest request)` Accepts an invitation to a resource share from another Amazon Web Services account.
`AssociateResourceShareResult`	`associateResourceShare(AssociateResourceShareRequest request)` Adds the specified list of principals and list of resources to a resource share.
`AssociateResourceSharePermissionResult`	`associateResourceSharePermission(AssociateResourceSharePermissionRequest request)` Adds or replaces the RAM permission for a resource type included in a resource share.
`CreateResourceShareResult`	`createResourceShare(CreateResourceShareRequest request)` Creates a resource share.
`DeleteResourceShareResult`	`deleteResourceShare(DeleteResourceShareRequest request)` Deletes the specified resource share.
`DisassociateResourceShareResult`	`disassociateResourceShare(DisassociateResourceShareRequest request)` Disassociates the specified principals or resources from the specified resource share.
`DisassociateResourceSharePermissionResult`	`disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest request)` Disassociates an RAM permission from a resource share.
`EnableSharingWithAwsOrganizationResult`	`enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request)` Enables resource sharing within your organization in Organizations.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetPermissionResult`	`getPermission(GetPermissionRequest request)` Gets the contents of an RAM permission in JSON format.
`GetResourcePoliciesResult`	`getResourcePolicies(GetResourcePoliciesRequest request)` Retrieves the resource policies for the specified resources that you own and have shared.
`GetResourceShareAssociationsResult`	`getResourceShareAssociations(GetResourceShareAssociationsRequest request)` Retrieves the resource and principal associations for resource shares that you own.
`GetResourceShareInvitationsResult`	`getResourceShareInvitations(GetResourceShareInvitationsRequest request)` Retrieves details about invitations that you have received for resource shares.
`GetResourceSharesResult`	`getResourceShares(GetResourceSharesRequest request)` Retrieves details about the resource shares that you own or that are shared with you.
`ListPendingInvitationResourcesResult`	`listPendingInvitationResources(ListPendingInvitationResourcesRequest request)` Lists the resources in a resource share that is shared with you but for which the invitation is still `PENDING`.
`ListPermissionsResult`	`listPermissions(ListPermissionsRequest request)` Retrieves a list of available RAM permissions that you can use for the supported resource types.
`ListPermissionVersionsResult`	`listPermissionVersions(ListPermissionVersionsRequest request)` Lists the available versions of the specified RAM permission.
`ListPrincipalsResult`	`listPrincipals(ListPrincipalsRequest request)` Lists the principals that you are sharing resources with or that are sharing resources with you.
`ListResourcesResult`	`listResources(ListResourcesRequest request)` Lists the resources that you added to a resource share or the resources that are shared with you.
`ListResourceSharePermissionsResult`	`listResourceSharePermissions(ListResourceSharePermissionsRequest request)` Lists the RAM permissions that are associated with a resource share.
`ListResourceTypesResult`	`listResourceTypes(ListResourceTypesRequest request)` Lists the resource types that can be shared by RAM.
`PromoteResourceShareCreatedFromPolicyResult`	`promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest request)` When you attach a resource-based permission policy to a resource, it automatically creates a resource share.
`RejectResourceShareInvitationResult`	`rejectResourceShareInvitation(RejectResourceShareInvitationRequest request)` Rejects an invitation to a resource share from another Amazon Web Services account.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds the specified tag keys and values to the specified resource share.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the specified tag key and value pairs from the specified resource share.
`UpdateResourceShareResult`	`updateResourceShare(UpdateResourceShareRequest request)` Modifies some of the properties of the specified resource share.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - acceptResourceShareInvitation
```
public AcceptResourceShareInvitationResult acceptResourceShareInvitation(AcceptResourceShareInvitationRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    Specified by:
    
    acceptResourceShareInvitation in interface AWSRAM
    
    Returns:
    
    Result of the AcceptResourceShareInvitation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - associateResourceShare
```
public AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    Specified by:
    
    associateResourceShare in interface AWSRAM
    
    Returns:
    
    Result of the AssociateResourceShare operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - associateResourceSharePermission
```
public AssociateResourceSharePermissionResult associateResourceSharePermission(AssociateResourceSharePermissionRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    Specified by:
    
    associateResourceSharePermission in interface AWSRAM
    
    Returns:
    
    Result of the AssociateResourceSharePermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createResourceShare
```
public CreateResourceShareResult createResourceShare(CreateResourceShareRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    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.
    
    Specified by:
    
    createResourceShare in interface AWSRAM
    
    Returns:
    
    Result of the CreateResourceShare operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteResourceShare
```
public DeleteResourceShareResult deleteResourceShare(DeleteResourceShareRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    Specified by:
    
    deleteResourceShare in interface AWSRAM
    
    Returns:
    
    Result of the DeleteResourceShare operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateResourceShare
```
public DisassociateResourceShareResult disassociateResourceShare(DisassociateResourceShareRequest request)
```
    Description copied from interface: AWSRAM
    
    Disassociates the specified principals or resources from the specified resource share.
    
    Specified by:
    
    disassociateResourceShare in interface AWSRAM
    
    Returns:
    
    Result of the DisassociateResourceShare operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateResourceSharePermission
```
public DisassociateResourceSharePermissionResult disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    Specified by:
    
    disassociateResourceSharePermission in interface AWSRAM
    
    Returns:
    
    Result of the DisassociateResourceSharePermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableSharingWithAwsOrganization
```
public EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    Specified by:
    
    enableSharingWithAwsOrganization in interface AWSRAM
    
    Returns:
    
    Result of the EnableSharingWithAwsOrganization operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPermission
```
public GetPermissionResult getPermission(GetPermissionRequest request)
```
    Description copied from interface: AWSRAM
    
    Gets the contents of an RAM permission in JSON format.
    
    Specified by:
    
    getPermission in interface AWSRAM
    
    Returns:
    
    Result of the GetPermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getResourcePolicies
```
public GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest request)
```
    Description copied from interface: AWSRAM
    
    Retrieves the resource policies for the specified resources that you own and have shared.
    
    Specified by:
    
    getResourcePolicies in interface AWSRAM
    
    Returns:
    
    Result of the GetResourcePolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getResourceShareAssociations
```
public GetResourceShareAssociationsResult getResourceShareAssociations(GetResourceShareAssociationsRequest request)
```
    Description copied from interface: AWSRAM
    
    Retrieves the resource and principal associations for resource shares that you own.
    
    Specified by:
    
    getResourceShareAssociations in interface AWSRAM
    
    Returns:
    
    Result of the GetResourceShareAssociations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getResourceShareInvitations
```
public GetResourceShareInvitationsResult getResourceShareInvitations(GetResourceShareInvitationsRequest request)
```
    Description copied from interface: AWSRAM
    
    Retrieves details about invitations that you have received for resource shares.
    
    Specified by:
    
    getResourceShareInvitations in interface AWSRAM
    
    Returns:
    
    Result of the GetResourceShareInvitations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getResourceShares
```
public GetResourceSharesResult getResourceShares(GetResourceSharesRequest request)
```
    Description copied from interface: AWSRAM
    
    Retrieves details about the resource shares that you own or that are shared with you.
    
    Specified by:
    
    getResourceShares in interface AWSRAM
    
    Returns:
    
    Result of the GetResourceShares operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPendingInvitationResources
```
public ListPendingInvitationResourcesResult listPendingInvitationResources(ListPendingInvitationResourcesRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    Specified by:
    
    listPendingInvitationResources in interface AWSRAM
    
    Returns:
    
    Result of the ListPendingInvitationResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPermissionVersions
```
public ListPermissionVersionsResult listPermissionVersions(ListPermissionVersionsRequest request)
```
    Description copied from interface: AWSRAM
    
    Lists the available versions of the specified RAM permission.
    
    Specified by:
    
    listPermissionVersions in interface AWSRAM
    
    Returns:
    
    Result of the ListPermissionVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPermissions
```
public ListPermissionsResult listPermissions(ListPermissionsRequest request)
```
    Description copied from interface: AWSRAM
    
    Retrieves a list of available RAM permissions that you can use for the supported resource types.
    
    Specified by:
    
    listPermissions in interface AWSRAM
    
    Returns:
    
    Result of the ListPermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPrincipals
```
public ListPrincipalsResult listPrincipals(ListPrincipalsRequest request)
```
    Description copied from interface: AWSRAM
    
    Lists the principals that you are sharing resources with or that are sharing resources with you.
    
    Specified by:
    
    listPrincipals in interface AWSRAM
    
    Returns:
    
    Result of the ListPrincipals operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listResourceSharePermissions
```
public ListResourceSharePermissionsResult listResourceSharePermissions(ListResourceSharePermissionsRequest request)
```
    Description copied from interface: AWSRAM
    
    Lists the RAM permissions that are associated with a resource share.
    
    Specified by:
    
    listResourceSharePermissions in interface AWSRAM
    
    Returns:
    
    Result of the ListResourceSharePermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listResourceTypes
```
public ListResourceTypesResult listResourceTypes(ListResourceTypesRequest request)
```
    Description copied from interface: AWSRAM
    
    Lists the resource types that can be shared by RAM.
    
    Specified by:
    
    listResourceTypes in interface AWSRAM
    
    Returns:
    
    Result of the ListResourceTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listResources
```
public ListResourcesResult listResources(ListResourcesRequest request)
```
    Description copied from interface: AWSRAM
    
    Lists the resources that you added to a resource share or the resources that are shared with you.
    
    Specified by:
    
    listResources in interface AWSRAM
    
    Returns:
    
    Result of the ListResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - promoteResourceShareCreatedFromPolicy
```
public PromoteResourceShareCreatedFromPolicyResult promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    Specified by:
    
    promoteResourceShareCreatedFromPolicy in interface AWSRAM
    
    Returns:
    
    Result of the PromoteResourceShareCreatedFromPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rejectResourceShareInvitation
```
public RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest request)
```
    Description copied from interface: AWSRAM
    
    Rejects an invitation to a resource share from another Amazon Web Services account.
    
    Specified by:
    
    rejectResourceShareInvitation in interface AWSRAM
    
    Returns:
    
    Result of the RejectResourceShareInvitation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSRAM
    
    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.
    
    Specified by:
    
    tagResource in interface AWSRAM
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSRAM
    
    Removes the specified tag key and value pairs from the specified resource share.
    
    Specified by:
    
    untagResource in interface AWSRAM
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateResourceShare
```
public UpdateResourceShareResult updateResourceShare(UpdateResourceShareRequest request)
```
    Description copied from interface: AWSRAM
    
    Modifies some of the properties of the specified resource share.
    
    Specified by:
    
    updateResourceShare in interface AWSRAM
    
    Returns:
    
    Result of the UpdateResourceShare operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSRAM
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSRAM
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSRAM
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSRAM
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSRAM

Field Summary

Fields inherited from interface com.amazonaws.services.ram.AWSRAM

Method Summary

Methods inherited from class java.lang.Object

Method Detail

acceptResourceShareInvitation

associateResourceShare

associateResourceSharePermission

createResourceShare

deleteResourceShare

disassociateResourceShare

disassociateResourceSharePermission

enableSharingWithAwsOrganization

getPermission

getResourcePolicies

getResourceShareAssociations

getResourceShareInvitations

getResourceShares

listPendingInvitationResources

listPermissionVersions

listPermissions

listPrincipals

listResourceSharePermissions

listResourceTypes

listResources

promoteResourceShareCreatedFromPolicy

rejectResourceShareInvitation

tagResource

untagResource

updateResourceShare

shutdown

getCachedResponseMetadata