com.amazonaws.services.ram.AWSRAM Maven / Gradle / Ivy
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ram;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.ram.model.*;
/**
* Interface for accessing RAM.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.ram.AbstractAWSRAM} instead.
*
*
*
* This is the Resource Access Manager API Reference. This documentation provides descriptions and syntax for
* each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services
* resources across Amazon Web Services accounts. If you have multiple Amazon Web Services accounts, you can use RAM to
* share those resources with other accounts. If you use Organizations to manage your accounts, then you share your
* resources with your organization or organizational units (OUs). For supported resource types, you can also share
* resources with individual Identity and Access Management (IAM) roles an users.
*
*
* To learn more about RAM, see the following resources:
*
*
* -
*
*
* -
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSRAM {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "ram";
/**
*
* 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.
*
*
* @param acceptResourceShareInvitationRequest
* @return Result of the AcceptResourceShareInvitation operation returned by the service.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws ResourceShareInvitationArnNotFoundException
* The specified Amazon Resource Name (ARN) for an invitation was not found.
* @throws ResourceShareInvitationAlreadyAcceptedException
* The specified invitation was already accepted.
* @throws ResourceShareInvitationAlreadyRejectedException
* The specified invitation was already rejected.
* @throws ResourceShareInvitationExpiredException
* The specified invitation is expired.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws InvalidClientTokenException
* The client token is not valid.
* @throws IdempotentParameterMismatchException
* The client token input parameter was matched one used with a previous call to the operation, but at least
* one of the other input parameters is different from the previous call.
* @sample AWSRAM.AcceptResourceShareInvitation
* @see AWS API Documentation
*/
AcceptResourceShareInvitationResult acceptResourceShareInvitation(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest);
/**
*
* 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.
*
*
* @param associateResourceShareRequest
* @return Result of the AssociateResourceShare operation returned by the service.
* @throws IdempotentParameterMismatchException
* The client token input parameter was matched one used with a previous call to the operation, but at least
* one of the other input parameters is different from the previous call.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws InvalidStateTransitionException
* The requested state transition is not valid.
* @throws ResourceShareLimitExceededException
* This request would exceed the limit for resource shares for your account.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidStateTransitionException
* The requested state transition is not valid.
* @throws InvalidClientTokenException
* The client token is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws ThrottlingException
* You exceeded the rate at which you are allowed to perform this operation. Please try again later.
* @sample AWSRAM.AssociateResourceShare
* @see AWS API
* Documentation
*/
AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest associateResourceShareRequest);
/**
*
* 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.
*
*
* @param associateResourceSharePermissionRequest
* @return Result of the AssociateResourceSharePermission operation returned by the service.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws InvalidClientTokenException
* The client token is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @sample AWSRAM.AssociateResourceSharePermission
* @see AWS API Documentation
*/
AssociateResourceSharePermissionResult associateResourceSharePermission(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest);
/**
*
* 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.
*
*
*
* @param createResourceShareRequest
* @return Result of the CreateResourceShare operation returned by the service.
* @throws IdempotentParameterMismatchException
* The client token input parameter was matched one used with a previous call to the operation, but at least
* one of the other input parameters is different from the previous call.
* @throws InvalidStateTransitionException
* The requested state transition is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidClientTokenException
* The client token is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws ResourceShareLimitExceededException
* This request would exceed the limit for resource shares for your account.
* @throws TagPolicyViolationException
* The specified tag key is a reserved word and can't be used.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.CreateResourceShare
* @see AWS API
* Documentation
*/
CreateResourceShareResult createResourceShare(CreateResourceShareRequest createResourceShareRequest);
/**
*
* 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.
*
*
* @param deleteResourceShareRequest
* @return Result of the DeleteResourceShare operation returned by the service.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws IdempotentParameterMismatchException
* The client token input parameter was matched one used with a previous call to the operation, but at least
* one of the other input parameters is different from the previous call.
* @throws InvalidStateTransitionException
* The requested state transition is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidClientTokenException
* The client token is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.DeleteResourceShare
* @see AWS API
* Documentation
*/
DeleteResourceShareResult deleteResourceShare(DeleteResourceShareRequest deleteResourceShareRequest);
/**
*
* Disassociates the specified principals or resources from the specified resource share.
*
*
* @param disassociateResourceShareRequest
* @return Result of the DisassociateResourceShare operation returned by the service.
* @throws IdempotentParameterMismatchException
* The client token input parameter was matched one used with a previous call to the operation, but at least
* one of the other input parameters is different from the previous call.
* @throws ResourceShareLimitExceededException
* This request would exceed the limit for resource shares for your account.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidStateTransitionException
* The requested state transition is not valid.
* @throws InvalidClientTokenException
* The client token is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws UnknownResourceException
* A specified resource was not found.
* @sample AWSRAM.DisassociateResourceShare
* @see AWS
* API Documentation
*/
DisassociateResourceShareResult disassociateResourceShare(DisassociateResourceShareRequest disassociateResourceShareRequest);
/**
*
* 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.
*
*
* @param disassociateResourceSharePermissionRequest
* @return Result of the DisassociateResourceSharePermission operation returned by the service.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws InvalidClientTokenException
* The client token is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws InvalidStateTransitionException
* The requested state transition is not valid.
* @sample AWSRAM.DisassociateResourceSharePermission
* @see AWS API Documentation
*/
DisassociateResourceSharePermissionResult disassociateResourceSharePermission(
DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest);
/**
*
* 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.
*
*
* @param enableSharingWithAwsOrganizationRequest
* @return Result of the EnableSharingWithAwsOrganization operation returned by the service.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.EnableSharingWithAwsOrganization
* @see AWS API Documentation
*/
EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest);
/**
*
* Gets the contents of an RAM permission in JSON format.
*
*
* @param getPermissionRequest
* @return Result of the GetPermission operation returned by the service.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @sample AWSRAM.GetPermission
* @see AWS API
* Documentation
*/
GetPermissionResult getPermission(GetPermissionRequest getPermissionRequest);
/**
*
* Retrieves the resource policies for the specified resources that you own and have shared.
*
*
* @param getResourcePoliciesRequest
* @return Result of the GetResourcePolicies operation returned by the service.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws ResourceArnNotFoundException
* The specified Amazon Resource Name (ARN) was not found.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.GetResourcePolicies
* @see AWS API
* Documentation
*/
GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest);
/**
*
* Retrieves the resource and principal associations for resource shares that you own.
*
*
* @param getResourceShareAssociationsRequest
* @return Result of the GetResourceShareAssociations operation returned by the service.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.GetResourceShareAssociations
* @see AWS API Documentation
*/
GetResourceShareAssociationsResult getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest);
/**
*
* Retrieves details about invitations that you have received for resource shares.
*
*
* @param getResourceShareInvitationsRequest
* @return Result of the GetResourceShareInvitations operation returned by the service.
* @throws ResourceShareInvitationArnNotFoundException
* The specified Amazon Resource Name (ARN) for an invitation was not found.
* @throws InvalidMaxResultsException
* The specified value for MaxResults is not valid.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.GetResourceShareInvitations
* @see AWS API Documentation
*/
GetResourceShareInvitationsResult getResourceShareInvitations(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest);
/**
*
* Retrieves details about the resource shares that you own or that are shared with you.
*
*
* @param getResourceSharesRequest
* @return Result of the GetResourceShares operation returned by the service.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.GetResourceShares
* @see AWS API
* Documentation
*/
GetResourceSharesResult getResourceShares(GetResourceSharesRequest getResourceSharesRequest);
/**
*
* 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.
*
*
* @param listPendingInvitationResourcesRequest
* @return Result of the ListPendingInvitationResources operation returned by the service.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws ResourceShareInvitationArnNotFoundException
* The specified Amazon Resource Name (ARN) for an invitation was not found.
* @throws MissingRequiredParameterException
* A required input parameter is missing.
* @throws ResourceShareInvitationAlreadyRejectedException
* The specified invitation was already rejected.
* @throws ResourceShareInvitationExpiredException
* The specified invitation is expired.
* @sample AWSRAM.ListPendingInvitationResources
* @see AWS API Documentation
*/
ListPendingInvitationResourcesResult listPendingInvitationResources(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest);
/**
*
* Lists the available versions of the specified RAM permission.
*
*
* @param listPermissionVersionsRequest
* @return Result of the ListPermissionVersions operation returned by the service.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws InvalidParameterException
* A parameter is not valid.
* @sample AWSRAM.ListPermissionVersions
* @see AWS API
* Documentation
*/
ListPermissionVersionsResult listPermissionVersions(ListPermissionVersionsRequest listPermissionVersionsRequest);
/**
*
* Retrieves a list of available RAM permissions that you can use for the supported resource types.
*
*
* @param listPermissionsRequest
* @return Result of the ListPermissions operation returned by the service.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @sample AWSRAM.ListPermissions
* @see AWS API
* Documentation
*/
ListPermissionsResult listPermissions(ListPermissionsRequest listPermissionsRequest);
/**
*
* Lists the principals that you are sharing resources with or that are sharing resources with you.
*
*
* @param listPrincipalsRequest
* @return Result of the ListPrincipals operation returned by the service.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.ListPrincipals
* @see AWS API
* Documentation
*/
ListPrincipalsResult listPrincipals(ListPrincipalsRequest listPrincipalsRequest);
/**
*
* Lists the RAM permissions that are associated with a resource share.
*
*
* @param listResourceSharePermissionsRequest
* @return Result of the ListResourceSharePermissions operation returned by the service.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @sample AWSRAM.ListResourceSharePermissions
* @see AWS API Documentation
*/
ListResourceSharePermissionsResult listResourceSharePermissions(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest);
/**
*
* Lists the resource types that can be shared by RAM.
*
*
* @param listResourceTypesRequest
* @return Result of the ListResourceTypes operation returned by the service.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.ListResourceTypes
* @see AWS API
* Documentation
*/
ListResourceTypesResult listResourceTypes(ListResourceTypesRequest listResourceTypesRequest);
/**
*
* Lists the resources that you added to a resource shares or the resources that are shared with you.
*
*
* @param listResourcesRequest
* @return Result of the ListResources operation returned by the service.
* @throws InvalidResourceTypeException
* The specified resource type is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidNextTokenException
* The specified value for NextToken is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.ListResources
* @see AWS API
* Documentation
*/
ListResourcesResult listResources(ListResourcesRequest listResourcesRequest);
/**
*
* 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.
*
*
* @param promoteResourceShareCreatedFromPolicyRequest
* @return Result of the PromoteResourceShareCreatedFromPolicy operation returned by the service.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws ResourceShareLimitExceededException
* This request would exceed the limit for resource shares for your account.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws MissingRequiredParameterException
* A required input parameter is missing.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws UnknownResourceException
* A specified resource was not found.
* @sample AWSRAM.PromoteResourceShareCreatedFromPolicy
* @see AWS API Documentation
*/
PromoteResourceShareCreatedFromPolicyResult promoteResourceShareCreatedFromPolicy(
PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest);
/**
*
* Rejects an invitation to a resource share from another Amazon Web Services account.
*
*
* @param rejectResourceShareInvitationRequest
* @return Result of the RejectResourceShareInvitation operation returned by the service.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws ResourceShareInvitationArnNotFoundException
* The specified Amazon Resource Name (ARN) for an invitation was not found.
* @throws ResourceShareInvitationAlreadyAcceptedException
* The specified invitation was already accepted.
* @throws ResourceShareInvitationAlreadyRejectedException
* The specified invitation was already rejected.
* @throws ResourceShareInvitationExpiredException
* The specified invitation is expired.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @throws InvalidClientTokenException
* The client token is not valid.
* @throws IdempotentParameterMismatchException
* The client token input parameter was matched one used with a previous call to the operation, but at least
* one of the other input parameters is different from the previous call.
* @sample AWSRAM.RejectResourceShareInvitation
* @see AWS API Documentation
*/
RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws TagLimitExceededException
* This request would exceed the limit for tags for your account.
* @throws ResourceArnNotFoundException
* The specified Amazon Resource Name (ARN) was not found.
* @throws TagPolicyViolationException
* The specified tag key is a reserved word and can't be used.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes the specified tag key and value pairs from the specified resource share.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Modifies some of the properties of the specified resource share.
*
*
* @param updateResourceShareRequest
* @return Result of the UpdateResourceShare operation returned by the service.
* @throws IdempotentParameterMismatchException
* The client token input parameter was matched one used with a previous call to the operation, but at least
* one of the other input parameters is different from the previous call.
* @throws MissingRequiredParameterException
* A required input parameter is missing.
* @throws UnknownResourceException
* A specified resource was not found.
* @throws MalformedArnException
* The format of an Amazon Resource Name (ARN) is not valid.
* @throws InvalidClientTokenException
* The client token is not valid.
* @throws InvalidParameterException
* A parameter is not valid.
* @throws OperationNotPermittedException
* The requested operation is not permitted.
* @throws ServerInternalException
* The service could not respond to the request due to an internal problem.
* @throws ServiceUnavailableException
* The service is not available.
* @sample AWSRAM.UpdateResourceShare
* @see AWS API
* Documentation
*/
UpdateResourceShareResult updateResourceShare(UpdateResourceShareRequest updateResourceShareRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy