Class: Aws::Repostspace::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Repostspace::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-repostspace/client.rb
Overview
An API client for Repostspace. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Repostspace::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#batch_add_role(params = {}) ⇒ Types::BatchAddRoleOutput
Add role to multiple users or groups in a private re:Post.
-
#batch_remove_role(params = {}) ⇒ Types::BatchRemoveRoleOutput
Remove role from multiple users or groups in a private re:Post.
-
#create_space(params = {}) ⇒ Types::CreateSpaceOutput
Creates an AWS re:Post Private private re:Post.
-
#delete_space(params = {}) ⇒ Struct
Deletes an AWS re:Post Private private re:Post.
-
#deregister_admin(params = {}) ⇒ Struct
Removes the user or group from the list of administrators of the private re:Post.
-
#get_space(params = {}) ⇒ Types::GetSpaceOutput
Displays information about the AWS re:Post Private private re:Post.
-
#list_spaces(params = {}) ⇒ Types::ListSpacesOutput
Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns the tags that are associated with the AWS re:Post Private resource specified by the resourceArn.
-
#register_admin(params = {}) ⇒ Struct
Adds a user or group to the list of administrators of the private re:Post.
-
#send_invites(params = {}) ⇒ Struct
Sends an invitation email to selected users and groups.
-
#tag_resource(params = {}) ⇒ Struct
Associates tags with an AWS re:Post Private resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the association of the tag with the AWS re:Post Private resource.
-
#update_space(params = {}) ⇒ Struct
Modifies an existing AWS re:Post Private private re:Post.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'lib/aws-sdk-repostspace/client.rb', line 444 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
991 992 993 |
# File 'lib/aws-sdk-repostspace/client.rb', line 991 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
994 995 996 |
# File 'lib/aws-sdk-repostspace/client.rb', line 994 def errors_module Errors end |
Instance Method Details
#batch_add_role(params = {}) ⇒ Types::BatchAddRoleOutput
Add role to multiple users or groups in a private re:Post.
487 488 489 490 |
# File 'lib/aws-sdk-repostspace/client.rb', line 487 def batch_add_role(params = {}, = {}) req = build_request(:batch_add_role, params) req.send_request() end |
#batch_remove_role(params = {}) ⇒ Types::BatchRemoveRoleOutput
Remove role from multiple users or groups in a private re:Post.
529 530 531 532 |
# File 'lib/aws-sdk-repostspace/client.rb', line 529 def batch_remove_role(params = {}, = {}) req = build_request(:batch_remove_role, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 |
# File 'lib/aws-sdk-repostspace/client.rb', line 964 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::Repostspace') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-repostspace' context[:gem_version] = '1.16.0' Seahorse::Client::Request.new(handlers, context) end |
#create_space(params = {}) ⇒ Types::CreateSpaceOutput
Creates an AWS re:Post Private private re:Post.
590 591 592 593 |
# File 'lib/aws-sdk-repostspace/client.rb', line 590 def create_space(params = {}, = {}) req = build_request(:create_space, params) req.send_request() end |
#delete_space(params = {}) ⇒ Struct
Deletes an AWS re:Post Private private re:Post.
612 613 614 615 |
# File 'lib/aws-sdk-repostspace/client.rb', line 612 def delete_space(params = {}, = {}) req = build_request(:delete_space, params) req.send_request() end |
#deregister_admin(params = {}) ⇒ Struct
Removes the user or group from the list of administrators of the private re:Post.
639 640 641 642 |
# File 'lib/aws-sdk-repostspace/client.rb', line 639 def deregister_admin(params = {}, = {}) req = build_request(:deregister_admin, params) req.send_request() end |
#get_space(params = {}) ⇒ Types::GetSpaceOutput
Displays information about the AWS re:Post Private private re:Post.
711 712 713 714 |
# File 'lib/aws-sdk-repostspace/client.rb', line 711 def get_space(params = {}, = {}) req = build_request(:get_space, params) req.send_request() end |
#list_spaces(params = {}) ⇒ Types::ListSpacesOutput
Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
765 766 767 768 |
# File 'lib/aws-sdk-repostspace/client.rb', line 765 def list_spaces(params = {}, = {}) req = build_request(:list_spaces, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns the tags that are associated with the AWS re:Post Private resource specified by the resourceArn. The only resource that can be tagged is a private re:Post.
796 797 798 799 |
# File 'lib/aws-sdk-repostspace/client.rb', line 796 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#register_admin(params = {}) ⇒ Struct
Adds a user or group to the list of administrators of the private re:Post.
823 824 825 826 |
# File 'lib/aws-sdk-repostspace/client.rb', line 823 def register_admin(params = {}, = {}) req = build_request(:register_admin, params) req.send_request() end |
#send_invites(params = {}) ⇒ Struct
Sends an invitation email to selected users and groups.
857 858 859 860 |
# File 'lib/aws-sdk-repostspace/client.rb', line 857 def send_invites(params = {}, = {}) req = build_request(:send_invites, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates tags with an AWS re:Post Private resource. Currently, the only resource that can be tagged is the private re:Post. If you specify a new tag key for the resource, the tag is appended to the list of tags that are associated with the resource. If you specify a tag key that’s already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
892 893 894 895 |
# File 'lib/aws-sdk-repostspace/client.rb', line 892 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the association of the tag with the AWS re:Post Private resource.
919 920 921 922 |
# File 'lib/aws-sdk-repostspace/client.rb', line 919 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_space(params = {}) ⇒ Struct
Modifies an existing AWS re:Post Private private re:Post.
955 956 957 958 |
# File 'lib/aws-sdk-repostspace/client.rb', line 955 def update_space(params = {}, = {}) req = build_request(:update_space, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
984 985 986 |
# File 'lib/aws-sdk-repostspace/client.rb', line 984 def waiter_names [] end |