Class: Aws::RAM::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::RAM::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb
Overview
An API client for RAM. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::RAM::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_resource_share_invitation(params = {}) ⇒ Types::AcceptResourceShareInvitationResponse
Accepts an invitation to a resource share from another AWS account.
-
#associate_resource_share(params = {}) ⇒ Types::AssociateResourceShareResponse
Associates the specified resource share with the specified principals and resources.
-
#associate_resource_share_permission(params = {}) ⇒ Types::AssociateResourceSharePermissionResponse
Associates a permission with a resource share.
-
#create_resource_share(params = {}) ⇒ Types::CreateResourceShareResponse
Creates a resource share.
-
#delete_resource_share(params = {}) ⇒ Types::DeleteResourceShareResponse
Deletes the specified resource share.
-
#disassociate_resource_share(params = {}) ⇒ Types::DisassociateResourceShareResponse
Disassociates the specified principals or resources from the specified resource share.
-
#disassociate_resource_share_permission(params = {}) ⇒ Types::DisassociateResourceSharePermissionResponse
Disassociates an AWS RAM permission from a resource share.
-
#enable_sharing_with_aws_organization(params = {}) ⇒ Types::EnableSharingWithAwsOrganizationResponse
Enables resource sharing within your AWS Organization.
-
#get_permission(params = {}) ⇒ Types::GetPermissionResponse
Gets the contents of an AWS RAM permission in JSON format.
-
#get_resource_policies(params = {}) ⇒ Types::GetResourcePoliciesResponse
Gets the policies for the specified resources that you own and have shared.
-
#get_resource_share_associations(params = {}) ⇒ Types::GetResourceShareAssociationsResponse
Gets the resources or principals for the resource shares that you own.
-
#get_resource_share_invitations(params = {}) ⇒ Types::GetResourceShareInvitationsResponse
Gets the invitations for resource sharing that you've received.
-
#get_resource_shares(params = {}) ⇒ Types::GetResourceSharesResponse
Gets the resource shares that you own or the resource shares that are shared with you.
-
#list_pending_invitation_resources(params = {}) ⇒ Types::ListPendingInvitationResourcesResponse
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
-
#list_permissions(params = {}) ⇒ Types::ListPermissionsResponse
Lists the AWS RAM permissions.
-
#list_principals(params = {}) ⇒ Types::ListPrincipalsResponse
Lists the principals that you have shared resources with or that have shared resources with you.
-
#list_resource_share_permissions(params = {}) ⇒ Types::ListResourceSharePermissionsResponse
Lists the AWS RAM permissions that are associated with a resource share.
-
#list_resource_types(params = {}) ⇒ Types::ListResourceTypesResponse
Lists the shareable resource types supported by AWS RAM.
-
#list_resources(params = {}) ⇒ Types::ListResourcesResponse
Lists the resources that you added to a resource shares or the resources that are shared with you.
-
#promote_resource_share_created_from_policy(params = {}) ⇒ Types::PromoteResourceShareCreatedFromPolicyResponse
Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.
-
#reject_resource_share_invitation(params = {}) ⇒ Types::RejectResourceShareInvitationResponse
Rejects an invitation to a resource share from another AWS account.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource share that you own.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource share that you own.
-
#update_resource_share(params = {}) ⇒ Types::UpdateResourceShareResponse
Updates the specified resource share that you own.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#accept_resource_share_invitation(params = {}) ⇒ Types::AcceptResourceShareInvitationResponse
Accepts an invitation to a resource share from another AWS account.
376 377 378 379 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 376 def accept_resource_share_invitation(params = {}, = {}) req = build_request(:accept_resource_share_invitation, params) req.send_request() end |
#associate_resource_share(params = {}) ⇒ Types::AssociateResourceShareResponse
Associates the specified resource share with the specified principals and resources.
429 430 431 432 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 429 def associate_resource_share(params = {}, = {}) req = build_request(:associate_resource_share, params) req.send_request() end |
#associate_resource_share_permission(params = {}) ⇒ Types::AssociateResourceSharePermissionResponse
Associates a permission with a resource share.
476 477 478 479 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 476 def (params = {}, = {}) req = build_request(:associate_resource_share_permission, params) req.send_request() end |
#create_resource_share(params = {}) ⇒ Types::CreateResourceShareResponse
Creates a resource share.
553 554 555 556 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 553 def create_resource_share(params = {}, = {}) req = build_request(:create_resource_share, params) req.send_request() end |
#delete_resource_share(params = {}) ⇒ Types::DeleteResourceShareResponse
Deletes the specified resource share.
588 589 590 591 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 588 def delete_resource_share(params = {}, = {}) req = build_request(:delete_resource_share, params) req.send_request() end |
#disassociate_resource_share(params = {}) ⇒ Types::DisassociateResourceShareResponse
Disassociates the specified principals or resources from the specified resource share.
641 642 643 644 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 641 def disassociate_resource_share(params = {}, = {}) req = build_request(:disassociate_resource_share, params) req.send_request() end |
#disassociate_resource_share_permission(params = {}) ⇒ Types::DisassociateResourceSharePermissionResponse
Disassociates an AWS RAM permission from a resource share.
680 681 682 683 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 680 def (params = {}, = {}) req = build_request(:disassociate_resource_share_permission, params) req.send_request() end |
#enable_sharing_with_aws_organization(params = {}) ⇒ Types::EnableSharingWithAwsOrganizationResponse
Enables resource sharing within your AWS Organization.
The caller must be the master account for the AWS Organization.
701 702 703 704 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 701 def enable_sharing_with_aws_organization(params = {}, = {}) req = build_request(:enable_sharing_with_aws_organization, params) req.send_request() end |
#get_permission(params = {}) ⇒ Types::GetPermissionResponse
Gets the contents of an AWS RAM permission in JSON format.
740 741 742 743 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 740 def (params = {}, = {}) req = build_request(:get_permission, params) req.send_request() end |
#get_resource_policies(params = {}) ⇒ Types::GetResourcePoliciesResponse
Gets the policies for the specified resources that you own and have shared.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
788 789 790 791 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 788 def get_resource_policies(params = {}, = {}) req = build_request(:get_resource_policies, params) req.send_request() end |
#get_resource_share_associations(params = {}) ⇒ Types::GetResourceShareAssociationsResponse
Gets the resources or principals for the resource shares that you own.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
860 861 862 863 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 860 def get_resource_share_associations(params = {}, = {}) req = build_request(:get_resource_share_associations, params) req.send_request() end |
#get_resource_share_invitations(params = {}) ⇒ Types::GetResourceShareInvitationsResponse
Gets the invitations for resource sharing that you've received.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
923 924 925 926 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 923 def get_resource_share_invitations(params = {}, = {}) req = build_request(:get_resource_share_invitations, params) req.send_request() end |
#get_resource_shares(params = {}) ⇒ Types::GetResourceSharesResponse
Gets the resource shares that you own or the resource shares that are shared with you.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
999 1000 1001 1002 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 999 def get_resource_shares(params = {}, = {}) req = build_request(:get_resource_shares, params) req.send_request() end |
#list_pending_invitation_resources(params = {}) ⇒ Types::ListPendingInvitationResourcesResponse
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1050 def list_pending_invitation_resources(params = {}, = {}) req = build_request(:list_pending_invitation_resources, params) req.send_request() end |
#list_permissions(params = {}) ⇒ Types::ListPermissionsResponse
Lists the AWS RAM permissions.
1100 1101 1102 1103 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1100 def (params = {}, = {}) req = build_request(:list_permissions, params) req.send_request() end |
#list_principals(params = {}) ⇒ Types::ListPrincipalsResponse
Lists the principals that you have shared resources with or that have shared resources with you.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1172 1173 1174 1175 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1172 def list_principals(params = {}, = {}) req = build_request(:list_principals, params) req.send_request() end |
#list_resource_share_permissions(params = {}) ⇒ Types::ListResourceSharePermissionsResponse
Lists the AWS RAM permissions that are associated with a resource share.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1221 def (params = {}, = {}) req = build_request(:list_resource_share_permissions, params) req.send_request() end |
#list_resource_types(params = {}) ⇒ Types::ListResourceTypesResponse
Lists the shareable resource types supported by AWS RAM.
1259 1260 1261 1262 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1259 def list_resource_types(params = {}, = {}) req = build_request(:list_resource_types, params) req.send_request() end |
#list_resources(params = {}) ⇒ Types::ListResourcesResponse
Lists the resources that you added to a resource shares or the resources that are shared with you.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1334 def list_resources(params = {}, = {}) req = build_request(:list_resources, params) req.send_request() end |
#promote_resource_share_created_from_policy(params = {}) ⇒ Types::PromoteResourceShareCreatedFromPolicyResponse
Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.
Use this API action to promote the resource share. When you promote the resource share, it becomes:
Visible to all principals that it is shared with.
Modifiable in AWS RAM.
1371 1372 1373 1374 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1371 def promote_resource_share_created_from_policy(params = {}, = {}) req = build_request(:promote_resource_share_created_from_policy, params) req.send_request() end |
#reject_resource_share_invitation(params = {}) ⇒ Types::RejectResourceShareInvitationResponse
Rejects an invitation to a resource share from another AWS account.
1422 1423 1424 1425 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1422 def reject_resource_share_invitation(params = {}, = {}) req = build_request(:reject_resource_share_invitation, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource share that you own.
1453 1454 1455 1456 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1453 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource share that you own.
1480 1481 1482 1483 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1480 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_resource_share(params = {}) ⇒ Types::UpdateResourceShareResponse
Updates the specified resource share that you own.
1535 1536 1537 1538 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/client.rb', line 1535 def update_resource_share(params = {}, = {}) req = build_request(:update_resource_share, params) req.send_request() end |