Class: Aws::AppRegistry::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppRegistry::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb
Overview
An API client for AppRegistry. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::AppRegistry::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
-
#associate_attribute_group(params = {}) ⇒ Types::AssociateAttributeGroupResponse
Associates an attribute group with an application to augment the application's metadata with the group's attributes.
-
#associate_resource(params = {}) ⇒ Types::AssociateResourceResponse
Associates a resource with an application.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
-
#create_attribute_group(params = {}) ⇒ Types::CreateAttributeGroupResponse
Creates a new attribute group as a container for user-defined attributes.
-
#delete_application(params = {}) ⇒ Types::DeleteApplicationResponse
Deletes an application that is specified either by its application ID or name.
-
#delete_attribute_group(params = {}) ⇒ Types::DeleteAttributeGroupResponse
Deletes an attribute group, specified either by its attribute group ID or name.
-
#disassociate_attribute_group(params = {}) ⇒ Types::DisassociateAttributeGroupResponse
Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata.
-
#disassociate_resource(params = {}) ⇒ Types::DisassociateResourceResponse
Disassociates a resource from application.
-
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Retrieves metadata information about one of your applications.
-
#get_associated_resource(params = {}) ⇒ Types::GetAssociatedResourceResponse
Gets the resource associated with the application.
-
#get_attribute_group(params = {}) ⇒ Types::GetAttributeGroupResponse
Retrieves an attribute group, either by its name or its ID.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Retrieves a list of all of your applications.
-
#list_associated_attribute_groups(params = {}) ⇒ Types::ListAssociatedAttributeGroupsResponse
Lists all attribute groups that are associated with specified application.
-
#list_associated_resources(params = {}) ⇒ Types::ListAssociatedResourcesResponse
Lists all resources that are associated with specified application.
-
#list_attribute_groups(params = {}) ⇒ Types::ListAttributeGroupsResponse
Lists all attribute groups which you have access to.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags on the resource.
-
#sync_resource(params = {}) ⇒ Types::SyncResourceResponse
Syncs the resource with current AppRegistry records.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates an existing application with new attributes.
-
#update_attribute_group(params = {}) ⇒ Types::UpdateAttributeGroupResponse
Updates an existing attribute group with new details.
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.
348 349 350 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#associate_attribute_group(params = {}) ⇒ Types::AssociateAttributeGroupResponse
Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.
387 388 389 390 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 387 def associate_attribute_group(params = {}, = {}) req = build_request(:associate_attribute_group, params) req.send_request() end |
#associate_resource(params = {}) ⇒ Types::AssociateResourceResponse
Associates a resource with an application. Both the resource and the application can be specified either by ID or name.
427 428 429 430 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 427 def associate_resource(params = {}, = {}) req = build_request(:associate_resource, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
486 487 488 489 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 486 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_attribute_group(params = {}) ⇒ Types::CreateAttributeGroupResponse
Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.
552 553 554 555 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 552 def create_attribute_group(params = {}, = {}) req = build_request(:create_attribute_group, params) req.send_request() end |
#delete_application(params = {}) ⇒ Types::DeleteApplicationResponse
Deletes an application that is specified either by its application ID or name. All associated attribute groups and resources must be disassociated from it before deleting an application.
587 588 589 590 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 587 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_attribute_group(params = {}) ⇒ Types::DeleteAttributeGroupResponse
Deletes an attribute group, specified either by its attribute group ID or name.
622 623 624 625 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 622 def delete_attribute_group(params = {}, = {}) req = build_request(:delete_attribute_group, params) req.send_request() end |
#disassociate_attribute_group(params = {}) ⇒ Types::DisassociateAttributeGroupResponse
Disassociates an attribute group from an application to remove the
extra attributes contained in the attribute group from the
application's metadata. This operation reverts
AssociateAttributeGroup
.
660 661 662 663 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 660 def disassociate_attribute_group(params = {}, = {}) req = build_request(:disassociate_attribute_group, params) req.send_request() end |
#disassociate_resource(params = {}) ⇒ Types::DisassociateResourceResponse
Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.
699 700 701 702 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 699 def disassociate_resource(params = {}, = {}) req = build_request(:disassociate_resource, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Retrieves metadata information about one of your applications. The
application can be specified either by its unique ID or by its name
(which is unique within one account in one region at a given point in
time). Specify by ID in automated workflows if you want to make sure
that the exact same application is returned or a
ResourceNotFoundException
is thrown, avoiding the ABA addressing
problem.
752 753 754 755 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 752 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_associated_resource(params = {}) ⇒ Types::GetAssociatedResourceResponse
Gets the resource associated with the application.
793 794 795 796 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 793 def get_associated_resource(params = {}, = {}) req = build_request(:get_associated_resource, params) req.send_request() end |
#get_attribute_group(params = {}) ⇒ Types::GetAttributeGroupResponse
Retrieves an attribute group, either by its name or its ID. The attribute group can be specified either by its unique ID or by its name.
839 840 841 842 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 839 def get_attribute_group(params = {}, = {}) req = build_request(:get_attribute_group, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Retrieves a list of all of your applications. Results are paginated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
884 885 886 887 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 884 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_associated_attribute_groups(params = {}) ⇒ Types::ListAssociatedAttributeGroupsResponse
Lists all attribute groups that are associated with specified application. Results are paginated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
929 930 931 932 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 929 def list_associated_attribute_groups(params = {}, = {}) req = build_request(:list_associated_attribute_groups, params) req.send_request() end |
#list_associated_resources(params = {}) ⇒ Types::ListAssociatedResourcesResponse
Lists all resources that are associated with specified application. Results are paginated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
975 976 977 978 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 975 def list_associated_resources(params = {}, = {}) req = build_request(:list_associated_resources, params) req.send_request() end |
#list_attribute_groups(params = {}) ⇒ Types::ListAttributeGroupsResponse
Lists all attribute groups which you have access to. Results are paginated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1021 1022 1023 1024 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1021 def list_attribute_groups(params = {}, = {}) req = build_request(:list_attribute_groups, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags on the resource.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1050 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#sync_resource(params = {}) ⇒ Types::SyncResourceResponse
Syncs the resource with current AppRegistry records.
Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1093 def sync_resource(params = {}, = {}) req = build_request(:sync_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified resource.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.
This operation returns an empty response if the call was successful.
1127 1128 1129 1130 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1127 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
This operation returns an empty response if the call was successful.
1155 1156 1157 1158 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1155 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates an existing application with new attributes.
1199 1200 1201 1202 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1199 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_attribute_group(params = {}) ⇒ Types::UpdateAttributeGroupResponse
Updates an existing attribute group with new details.
1250 1251 1252 1253 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1250 def update_attribute_group(params = {}, = {}) req = build_request(:update_attribute_group, params) req.send_request() end |