Skip to content

RAMClient#

Index > RAM > RAMClient

Auto-generated documentation for RAM type annotations stubs module mypy-boto3-ram.

RAMClient#

Type annotations and code completion for boto3.client("ram"). boto3 documentation

# RAMClient usage example

from boto3.session import Session
from mypy_boto3_ram.client import RAMClient

def get_ram_client() -> RAMClient:
    return Session().client("ram")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("ram").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("ram")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.IdempotentParameterMismatchException,
    client.exceptions.InvalidClientTokenException,
    client.exceptions.InvalidMaxResultsException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidPolicyException,
    client.exceptions.InvalidResourceTypeException,
    client.exceptions.InvalidStateTransitionException,
    client.exceptions.MalformedArnException,
    client.exceptions.MalformedPolicyTemplateException,
    client.exceptions.MissingRequiredParameterException,
    client.exceptions.OperationNotPermittedException,
    client.exceptions.PermissionAlreadyExistsException,
    client.exceptions.PermissionLimitExceededException,
    client.exceptions.PermissionVersionsLimitExceededException,
    client.exceptions.ResourceArnNotFoundException,
    client.exceptions.ResourceShareInvitationAlreadyAcceptedException,
    client.exceptions.ResourceShareInvitationAlreadyRejectedException,
    client.exceptions.ResourceShareInvitationArnNotFoundException,
    client.exceptions.ResourceShareInvitationExpiredException,
    client.exceptions.ResourceShareLimitExceededException,
    client.exceptions.ServerInternalException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.TagLimitExceededException,
    client.exceptions.TagPolicyViolationException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnknownResourceException,
    client.exceptions.UnmatchedPolicyPermissionException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_ram.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("ram").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("ram").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

accept_resource_share_invitation#

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

Type annotations and code completion for boto3.client("ram").accept_resource_share_invitation method. boto3 documentation

# accept_resource_share_invitation method definition

def accept_resource_share_invitation(
    self,
    *,
    resourceShareInvitationArn: str,
    clientToken: str = ...,
) -> AcceptResourceShareInvitationResponseTypeDef:  # (1)
    ...
  1. See AcceptResourceShareInvitationResponseTypeDef 
# accept_resource_share_invitation method usage example with argument unpacking

kwargs: AcceptResourceShareInvitationRequestRequestTypeDef = {  # (1)
    "resourceShareInvitationArn": ...,
}

parent.accept_resource_share_invitation(**kwargs)
  1. See AcceptResourceShareInvitationRequestRequestTypeDef

associate_resource_share#

Adds the specified list of principals and list of resources to a resource share.

Type annotations and code completion for boto3.client("ram").associate_resource_share method. boto3 documentation

# associate_resource_share method definition

def associate_resource_share(
    self,
    *,
    resourceShareArn: str,
    resourceArns: Sequence[str] = ...,
    principals: Sequence[str] = ...,
    clientToken: str = ...,
    sources: Sequence[str] = ...,
) -> AssociateResourceShareResponseTypeDef:  # (1)
    ...
  1. See AssociateResourceShareResponseTypeDef 
# associate_resource_share method usage example with argument unpacking

kwargs: AssociateResourceShareRequestRequestTypeDef = {  # (1)
    "resourceShareArn": ...,
}

parent.associate_resource_share(**kwargs)
  1. See AssociateResourceShareRequestRequestTypeDef

associate_resource_share_permission#

Adds or replaces the RAM permission for a resource type included in a resource share.

Type annotations and code completion for boto3.client("ram").associate_resource_share_permission method. boto3 documentation

# associate_resource_share_permission method definition

def associate_resource_share_permission(
    self,
    *,
    resourceShareArn: str,
    permissionArn: str,
    replace: bool = ...,
    clientToken: str = ...,
    permissionVersion: int = ...,
) -> AssociateResourceSharePermissionResponseTypeDef:  # (1)
    ...
  1. See AssociateResourceSharePermissionResponseTypeDef 
# associate_resource_share_permission method usage example with argument unpacking

kwargs: AssociateResourceSharePermissionRequestRequestTypeDef = {  # (1)
    "resourceShareArn": ...,
    "permissionArn": ...,
}

parent.associate_resource_share_permission(**kwargs)
  1. See AssociateResourceSharePermissionRequestRequestTypeDef

create_permission#

Creates a customer managed permission for a specified resource type that you can attach to resource shares.

Type annotations and code completion for boto3.client("ram").create_permission method. boto3 documentation

# create_permission method definition

def create_permission(
    self,
    *,
    name: str,
    resourceType: str,
    policyTemplate: str,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreatePermissionResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreatePermissionResponseTypeDef 
# create_permission method usage example with argument unpacking

kwargs: CreatePermissionRequestRequestTypeDef = {  # (1)
    "name": ...,
    "resourceType": ...,
    "policyTemplate": ...,
}

parent.create_permission(**kwargs)
  1. See CreatePermissionRequestRequestTypeDef

create_permission_version#

Creates a new version of the specified customer managed permission.

Type annotations and code completion for boto3.client("ram").create_permission_version method. boto3 documentation

# create_permission_version method definition

def create_permission_version(
    self,
    *,
    permissionArn: str,
    policyTemplate: str,
    clientToken: str = ...,
) -> CreatePermissionVersionResponseTypeDef:  # (1)
    ...
  1. See CreatePermissionVersionResponseTypeDef 
# create_permission_version method usage example with argument unpacking

kwargs: CreatePermissionVersionRequestRequestTypeDef = {  # (1)
    "permissionArn": ...,
    "policyTemplate": ...,
}

parent.create_permission_version(**kwargs)
  1. See CreatePermissionVersionRequestRequestTypeDef

create_resource_share#

Creates a resource share.

Type annotations and code completion for boto3.client("ram").create_resource_share method. boto3 documentation

# create_resource_share method definition

def create_resource_share(
    self,
    *,
    name: str,
    resourceArns: Sequence[str] = ...,
    principals: Sequence[str] = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    allowExternalPrincipals: bool = ...,
    clientToken: str = ...,
    permissionArns: Sequence[str] = ...,
    sources: Sequence[str] = ...,
) -> CreateResourceShareResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateResourceShareResponseTypeDef 
# create_resource_share method usage example with argument unpacking

kwargs: CreateResourceShareRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_resource_share(**kwargs)
  1. See CreateResourceShareRequestRequestTypeDef

delete_permission#

Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation.

Type annotations and code completion for boto3.client("ram").delete_permission method. boto3 documentation

# delete_permission method definition

def delete_permission(
    self,
    *,
    permissionArn: str,
    clientToken: str = ...,
) -> DeletePermissionResponseTypeDef:  # (1)
    ...
  1. See DeletePermissionResponseTypeDef 
# delete_permission method usage example with argument unpacking

kwargs: DeletePermissionRequestRequestTypeDef = {  # (1)
    "permissionArn": ...,
}

parent.delete_permission(**kwargs)
  1. See DeletePermissionRequestRequestTypeDef

delete_permission_version#

Deletes one version of a customer managed permission.

Type annotations and code completion for boto3.client("ram").delete_permission_version method. boto3 documentation

# delete_permission_version method definition

def delete_permission_version(
    self,
    *,
    permissionArn: str,
    permissionVersion: int,
    clientToken: str = ...,
) -> DeletePermissionVersionResponseTypeDef:  # (1)
    ...
  1. See DeletePermissionVersionResponseTypeDef 
# delete_permission_version method usage example with argument unpacking

kwargs: DeletePermissionVersionRequestRequestTypeDef = {  # (1)
    "permissionArn": ...,
    "permissionVersion": ...,
}

parent.delete_permission_version(**kwargs)
  1. See DeletePermissionVersionRequestRequestTypeDef

delete_resource_share#

Deletes the specified resource share.

Type annotations and code completion for boto3.client("ram").delete_resource_share method. boto3 documentation

# delete_resource_share method definition

def delete_resource_share(
    self,
    *,
    resourceShareArn: str,
    clientToken: str = ...,
) -> DeleteResourceShareResponseTypeDef:  # (1)
    ...
  1. See DeleteResourceShareResponseTypeDef 
# delete_resource_share method usage example with argument unpacking

kwargs: DeleteResourceShareRequestRequestTypeDef = {  # (1)
    "resourceShareArn": ...,
}

parent.delete_resource_share(**kwargs)
  1. See DeleteResourceShareRequestRequestTypeDef

disassociate_resource_share#

Removes the specified principals or resources from participating in the specified resource share.

Type annotations and code completion for boto3.client("ram").disassociate_resource_share method. boto3 documentation

# disassociate_resource_share method definition

def disassociate_resource_share(
    self,
    *,
    resourceShareArn: str,
    resourceArns: Sequence[str] = ...,
    principals: Sequence[str] = ...,
    clientToken: str = ...,
    sources: Sequence[str] = ...,
) -> DisassociateResourceShareResponseTypeDef:  # (1)
    ...
  1. See DisassociateResourceShareResponseTypeDef 
# disassociate_resource_share method usage example with argument unpacking

kwargs: DisassociateResourceShareRequestRequestTypeDef = {  # (1)
    "resourceShareArn": ...,
}

parent.disassociate_resource_share(**kwargs)
  1. See DisassociateResourceShareRequestRequestTypeDef

disassociate_resource_share_permission#

Removes a managed permission from a resource share.

Type annotations and code completion for boto3.client("ram").disassociate_resource_share_permission method. boto3 documentation

# disassociate_resource_share_permission method definition

def disassociate_resource_share_permission(
    self,
    *,
    resourceShareArn: str,
    permissionArn: str,
    clientToken: str = ...,
) -> DisassociateResourceSharePermissionResponseTypeDef:  # (1)
    ...
  1. See DisassociateResourceSharePermissionResponseTypeDef 
# disassociate_resource_share_permission method usage example with argument unpacking

kwargs: DisassociateResourceSharePermissionRequestRequestTypeDef = {  # (1)
    "resourceShareArn": ...,
    "permissionArn": ...,
}

parent.disassociate_resource_share_permission(**kwargs)
  1. See DisassociateResourceSharePermissionRequestRequestTypeDef

enable_sharing_with_aws_organization#

Enables resource sharing within your organization in Organizations.

Type annotations and code completion for boto3.client("ram").enable_sharing_with_aws_organization method. boto3 documentation

# enable_sharing_with_aws_organization method definition

def enable_sharing_with_aws_organization(
    self,
) -> EnableSharingWithAwsOrganizationResponseTypeDef:  # (1)
    ...
  1. See EnableSharingWithAwsOrganizationResponseTypeDef

get_permission#

Retrieves the contents of a managed permission in JSON format.

Type annotations and code completion for boto3.client("ram").get_permission method. boto3 documentation

# get_permission method definition

def get_permission(
    self,
    *,
    permissionArn: str,
    permissionVersion: int = ...,
) -> GetPermissionResponseTypeDef:  # (1)
    ...
  1. See GetPermissionResponseTypeDef 
# get_permission method usage example with argument unpacking

kwargs: GetPermissionRequestRequestTypeDef = {  # (1)
    "permissionArn": ...,
}

parent.get_permission(**kwargs)
  1. See GetPermissionRequestRequestTypeDef

get_resource_policies#

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

Type annotations and code completion for boto3.client("ram").get_resource_policies method. boto3 documentation

# get_resource_policies method definition

def get_resource_policies(
    self,
    *,
    resourceArns: Sequence[str],
    principal: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetResourcePoliciesResponseTypeDef:  # (1)
    ...
  1. See GetResourcePoliciesResponseTypeDef 
# get_resource_policies method usage example with argument unpacking

kwargs: GetResourcePoliciesRequestRequestTypeDef = {  # (1)
    "resourceArns": ...,
}

parent.get_resource_policies(**kwargs)
  1. See GetResourcePoliciesRequestRequestTypeDef

get_resource_share_associations#

Retrieves the lists of resources and principals that associated for resource shares that you own.

Type annotations and code completion for boto3.client("ram").get_resource_share_associations method. boto3 documentation

# get_resource_share_associations method definition

def get_resource_share_associations(
    self,
    *,
    associationType: ResourceShareAssociationTypeType,  # (1)
    resourceShareArns: Sequence[str] = ...,
    resourceArn: str = ...,
    principal: str = ...,
    associationStatus: ResourceShareAssociationStatusType = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetResourceShareAssociationsResponseTypeDef:  # (3)
    ...
  1. See ResourceShareAssociationTypeType
  2. See ResourceShareAssociationStatusType
  3. See GetResourceShareAssociationsResponseTypeDef 
# get_resource_share_associations method usage example with argument unpacking

kwargs: GetResourceShareAssociationsRequestRequestTypeDef = {  # (1)
    "associationType": ...,
}

parent.get_resource_share_associations(**kwargs)
  1. See GetResourceShareAssociationsRequestRequestTypeDef

get_resource_share_invitations#

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

Type annotations and code completion for boto3.client("ram").get_resource_share_invitations method. boto3 documentation

# get_resource_share_invitations method definition

def get_resource_share_invitations(
    self,
    *,
    resourceShareInvitationArns: Sequence[str] = ...,
    resourceShareArns: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetResourceShareInvitationsResponseTypeDef:  # (1)
    ...
  1. See GetResourceShareInvitationsResponseTypeDef 
# get_resource_share_invitations method usage example with argument unpacking

kwargs: GetResourceShareInvitationsRequestRequestTypeDef = {  # (1)
    "resourceShareInvitationArns": ...,
}

parent.get_resource_share_invitations(**kwargs)
  1. See GetResourceShareInvitationsRequestRequestTypeDef

get_resource_shares#

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

Type annotations and code completion for boto3.client("ram").get_resource_shares method. boto3 documentation

# get_resource_shares method definition

def get_resource_shares(
    self,
    *,
    resourceOwner: ResourceOwnerType,  # (1)
    resourceShareArns: Sequence[str] = ...,
    resourceShareStatus: ResourceShareStatusType = ...,  # (2)
    name: str = ...,
    tagFilters: Sequence[TagFilterTypeDef] = ...,  # (3)
    nextToken: str = ...,
    maxResults: int = ...,
    permissionArn: str = ...,
    permissionVersion: int = ...,
) -> GetResourceSharesResponseTypeDef:  # (4)
    ...
  1. See ResourceOwnerType
  2. See ResourceShareStatusType
  3. See TagFilterTypeDef
  4. See GetResourceSharesResponseTypeDef 
# get_resource_shares method usage example with argument unpacking

kwargs: GetResourceSharesRequestRequestTypeDef = {  # (1)
    "resourceOwner": ...,
}

parent.get_resource_shares(**kwargs)
  1. See GetResourceSharesRequestRequestTypeDef

list_pending_invitation_resources#

Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING.

Type annotations and code completion for boto3.client("ram").list_pending_invitation_resources method. boto3 documentation

# list_pending_invitation_resources method definition

def list_pending_invitation_resources(
    self,
    *,
    resourceShareInvitationArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
    resourceRegionScope: ResourceRegionScopeFilterType = ...,  # (1)
) -> ListPendingInvitationResourcesResponseTypeDef:  # (2)
    ...
  1. See ResourceRegionScopeFilterType
  2. See ListPendingInvitationResourcesResponseTypeDef 
# list_pending_invitation_resources method usage example with argument unpacking

kwargs: ListPendingInvitationResourcesRequestRequestTypeDef = {  # (1)
    "resourceShareInvitationArn": ...,
}

parent.list_pending_invitation_resources(**kwargs)
  1. See ListPendingInvitationResourcesRequestRequestTypeDef

list_permission_associations#

Lists information about the managed permission and its associations to any resource shares that use this managed permission.

Type annotations and code completion for boto3.client("ram").list_permission_associations method. boto3 documentation

# list_permission_associations method definition

def list_permission_associations(
    self,
    *,
    permissionArn: str = ...,
    permissionVersion: int = ...,
    associationStatus: ResourceShareAssociationStatusType = ...,  # (1)
    resourceType: str = ...,
    featureSet: PermissionFeatureSetType = ...,  # (2)
    defaultVersion: bool = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPermissionAssociationsResponseTypeDef:  # (3)
    ...
  1. See ResourceShareAssociationStatusType
  2. See PermissionFeatureSetType
  3. See ListPermissionAssociationsResponseTypeDef 
# list_permission_associations method usage example with argument unpacking

kwargs: ListPermissionAssociationsRequestRequestTypeDef = {  # (1)
    "permissionArn": ...,
}

parent.list_permission_associations(**kwargs)
  1. See ListPermissionAssociationsRequestRequestTypeDef

list_permission_versions#

Lists the available versions of the specified RAM permission.

Type annotations and code completion for boto3.client("ram").list_permission_versions method. boto3 documentation

# list_permission_versions method definition

def list_permission_versions(
    self,
    *,
    permissionArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPermissionVersionsResponseTypeDef:  # (1)
    ...
  1. See ListPermissionVersionsResponseTypeDef 
# list_permission_versions method usage example with argument unpacking

kwargs: ListPermissionVersionsRequestRequestTypeDef = {  # (1)
    "permissionArn": ...,
}

parent.list_permission_versions(**kwargs)
  1. See ListPermissionVersionsRequestRequestTypeDef

list_permissions#

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

Type annotations and code completion for boto3.client("ram").list_permissions method. boto3 documentation

# list_permissions method definition

def list_permissions(
    self,
    *,
    resourceType: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    permissionType: PermissionTypeFilterType = ...,  # (1)
) -> ListPermissionsResponseTypeDef:  # (2)
    ...
  1. See PermissionTypeFilterType
  2. See ListPermissionsResponseTypeDef 
# list_permissions method usage example with argument unpacking

kwargs: ListPermissionsRequestRequestTypeDef = {  # (1)
    "resourceType": ...,
}

parent.list_permissions(**kwargs)
  1. See ListPermissionsRequestRequestTypeDef

list_principals#

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

Type annotations and code completion for boto3.client("ram").list_principals method. boto3 documentation

# list_principals method definition

def list_principals(
    self,
    *,
    resourceOwner: ResourceOwnerType,  # (1)
    resourceArn: str = ...,
    principals: Sequence[str] = ...,
    resourceType: str = ...,
    resourceShareArns: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPrincipalsResponseTypeDef:  # (2)
    ...
  1. See ResourceOwnerType
  2. See ListPrincipalsResponseTypeDef 
# list_principals method usage example with argument unpacking

kwargs: ListPrincipalsRequestRequestTypeDef = {  # (1)
    "resourceOwner": ...,
}

parent.list_principals(**kwargs)
  1. See ListPrincipalsRequestRequestTypeDef

list_replace_permission_associations_work#

Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.

Type annotations and code completion for boto3.client("ram").list_replace_permission_associations_work method. boto3 documentation

# list_replace_permission_associations_work method definition

def list_replace_permission_associations_work(
    self,
    *,
    workIds: Sequence[str] = ...,
    status: ReplacePermissionAssociationsWorkStatusType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListReplacePermissionAssociationsWorkResponseTypeDef:  # (2)
    ...
  1. See ReplacePermissionAssociationsWorkStatusType
  2. See ListReplacePermissionAssociationsWorkResponseTypeDef 
# list_replace_permission_associations_work method usage example with argument unpacking

kwargs: ListReplacePermissionAssociationsWorkRequestRequestTypeDef = {  # (1)
    "workIds": ...,
}

parent.list_replace_permission_associations_work(**kwargs)
  1. See ListReplacePermissionAssociationsWorkRequestRequestTypeDef

list_resource_share_permissions#

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

Type annotations and code completion for boto3.client("ram").list_resource_share_permissions method. boto3 documentation

# list_resource_share_permissions method definition

def list_resource_share_permissions(
    self,
    *,
    resourceShareArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListResourceSharePermissionsResponseTypeDef:  # (1)
    ...
  1. See ListResourceSharePermissionsResponseTypeDef 
# list_resource_share_permissions method usage example with argument unpacking

kwargs: ListResourceSharePermissionsRequestRequestTypeDef = {  # (1)
    "resourceShareArn": ...,
}

parent.list_resource_share_permissions(**kwargs)
  1. See ListResourceSharePermissionsRequestRequestTypeDef

list_resource_types#

Lists the resource types that can be shared by RAM.

Type annotations and code completion for boto3.client("ram").list_resource_types method. boto3 documentation

# list_resource_types method definition

def list_resource_types(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    resourceRegionScope: ResourceRegionScopeFilterType = ...,  # (1)
) -> ListResourceTypesResponseTypeDef:  # (2)
    ...
  1. See ResourceRegionScopeFilterType
  2. See ListResourceTypesResponseTypeDef 
# list_resource_types method usage example with argument unpacking

kwargs: ListResourceTypesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_resource_types(**kwargs)
  1. See ListResourceTypesRequestRequestTypeDef

list_resources#

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

Type annotations and code completion for boto3.client("ram").list_resources method. boto3 documentation

# list_resources method definition

def list_resources(
    self,
    *,
    resourceOwner: ResourceOwnerType,  # (1)
    principal: str = ...,
    resourceType: str = ...,
    resourceArns: Sequence[str] = ...,
    resourceShareArns: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    resourceRegionScope: ResourceRegionScopeFilterType = ...,  # (2)
) -> ListResourcesResponseTypeDef:  # (3)
    ...
  1. See ResourceOwnerType
  2. See ResourceRegionScopeFilterType
  3. See ListResourcesResponseTypeDef 
# list_resources method usage example with argument unpacking

kwargs: ListResourcesRequestRequestTypeDef = {  # (1)
    "resourceOwner": ...,
}

parent.list_resources(**kwargs)
  1. See ListResourcesRequestRequestTypeDef

promote_permission_created_from_policy#

When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy.

Type annotations and code completion for boto3.client("ram").promote_permission_created_from_policy method. boto3 documentation

# promote_permission_created_from_policy method definition

def promote_permission_created_from_policy(
    self,
    *,
    permissionArn: str,
    name: str,
    clientToken: str = ...,
) -> PromotePermissionCreatedFromPolicyResponseTypeDef:  # (1)
    ...
  1. See PromotePermissionCreatedFromPolicyResponseTypeDef 
# promote_permission_created_from_policy method usage example with argument unpacking

kwargs: PromotePermissionCreatedFromPolicyRequestRequestTypeDef = {  # (1)
    "permissionArn": ...,
    "name": ...,
}

parent.promote_permission_created_from_policy(**kwargs)
  1. See PromotePermissionCreatedFromPolicyRequestRequestTypeDef

promote_resource_share_created_from_policy#

When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy.

Type annotations and code completion for boto3.client("ram").promote_resource_share_created_from_policy method. boto3 documentation

# promote_resource_share_created_from_policy method definition

def promote_resource_share_created_from_policy(
    self,
    *,
    resourceShareArn: str,
) -> PromoteResourceShareCreatedFromPolicyResponseTypeDef:  # (1)
    ...
  1. See PromoteResourceShareCreatedFromPolicyResponseTypeDef 
# promote_resource_share_created_from_policy method usage example with argument unpacking

kwargs: PromoteResourceShareCreatedFromPolicyRequestRequestTypeDef = {  # (1)
    "resourceShareArn": ...,
}

parent.promote_resource_share_created_from_policy(**kwargs)
  1. See PromoteResourceShareCreatedFromPolicyRequestRequestTypeDef

reject_resource_share_invitation#

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

Type annotations and code completion for boto3.client("ram").reject_resource_share_invitation method. boto3 documentation

# reject_resource_share_invitation method definition

def reject_resource_share_invitation(
    self,
    *,
    resourceShareInvitationArn: str,
    clientToken: str = ...,
) -> RejectResourceShareInvitationResponseTypeDef:  # (1)
    ...
  1. See RejectResourceShareInvitationResponseTypeDef 
# reject_resource_share_invitation method usage example with argument unpacking

kwargs: RejectResourceShareInvitationRequestRequestTypeDef = {  # (1)
    "resourceShareInvitationArn": ...,
}

parent.reject_resource_share_invitation(**kwargs)
  1. See RejectResourceShareInvitationRequestRequestTypeDef

replace_permission_associations#

Updates all resource shares that use a managed permission to a different managed permission.

Type annotations and code completion for boto3.client("ram").replace_permission_associations method. boto3 documentation

# replace_permission_associations method definition

def replace_permission_associations(
    self,
    *,
    fromPermissionArn: str,
    toPermissionArn: str,
    fromPermissionVersion: int = ...,
    clientToken: str = ...,
) -> ReplacePermissionAssociationsResponseTypeDef:  # (1)
    ...
  1. See ReplacePermissionAssociationsResponseTypeDef 
# replace_permission_associations method usage example with argument unpacking

kwargs: ReplacePermissionAssociationsRequestRequestTypeDef = {  # (1)
    "fromPermissionArn": ...,
    "toPermissionArn": ...,
}

parent.replace_permission_associations(**kwargs)
  1. See ReplacePermissionAssociationsRequestRequestTypeDef

set_default_permission_version#

Designates the specified version number as the default version for the specified customer managed permission.

Type annotations and code completion for boto3.client("ram").set_default_permission_version method. boto3 documentation

# set_default_permission_version method definition

def set_default_permission_version(
    self,
    *,
    permissionArn: str,
    permissionVersion: int,
    clientToken: str = ...,
) -> SetDefaultPermissionVersionResponseTypeDef:  # (1)
    ...
  1. See SetDefaultPermissionVersionResponseTypeDef 
# set_default_permission_version method usage example with argument unpacking

kwargs: SetDefaultPermissionVersionRequestRequestTypeDef = {  # (1)
    "permissionArn": ...,
    "permissionVersion": ...,
}

parent.set_default_permission_version(**kwargs)
  1. See SetDefaultPermissionVersionRequestRequestTypeDef

tag_resource#

Adds the specified tag keys and values to a resource share or managed permission.

Type annotations and code completion for boto3.client("ram").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    tags: Sequence[TagTypeDef],  # (1)
    resourceShareArn: str = ...,
    resourceArn: str = ...,
) -> dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

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

Type annotations and code completion for boto3.client("ram").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    tagKeys: Sequence[str],
    resourceShareArn: str = ...,
    resourceArn: str = ...,
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_resource_share#

Modifies some of the properties of the specified resource share.

Type annotations and code completion for boto3.client("ram").update_resource_share method. boto3 documentation

# update_resource_share method definition

def update_resource_share(
    self,
    *,
    resourceShareArn: str,
    name: str = ...,
    allowExternalPrincipals: bool = ...,
    clientToken: str = ...,
) -> UpdateResourceShareResponseTypeDef:  # (1)
    ...
  1. See UpdateResourceShareResponseTypeDef 
# update_resource_share method usage example with argument unpacking

kwargs: UpdateResourceShareRequestRequestTypeDef = {  # (1)
    "resourceShareArn": ...,
}

parent.update_resource_share(**kwargs)
  1. See UpdateResourceShareRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("ram").get_paginator method with overloads.