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, name, or ARN.
-
#delete_attribute_group(params = {}) ⇒ Types::DeleteAttributeGroupResponse
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
-
#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 by its ARN, ID, or name.
-
#get_configuration(params = {}) ⇒ Types::GetConfigurationResponse
Retrieves a
TagKey
configuration from an account. -
#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 of the resources that are associated with the specified application.
-
#list_attribute_groups(params = {}) ⇒ Types::ListAttributeGroupsResponse
Lists all attribute groups which you have access to.
-
#list_attribute_groups_for_application(params = {}) ⇒ Types::ListAttributeGroupsForApplicationResponse
Lists the details of all attribute groups associated with a specific application.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags on the resource.
-
#put_configuration(params = {}) ⇒ Struct
Associates a
TagKey
configuration to an account. -
#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.
410 411 412 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 410 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.
449 450 451 452 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 449 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. The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name.
Minimum permissions
You must have the following permissions to associate a resource using
the OPTIONS
parameter set to APPLY_APPLICATION_TAG
.
tag:GetResources
tag:TagResources
You must also have these additional permissions if you don't use the
AWSServiceCatalogAppRegistryFullAccess
policy. For more information,
see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry
Administrator Guide.
resource-groups:AssociateResource
cloudformation:UpdateStack
cloudformation:DescribeStacks
529 530 531 532 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 529 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.
590 591 592 593 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 590 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.
656 657 658 659 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 656 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, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.
691 692 693 694 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 691 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, name, or ARN.
727 728 729 730 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 727 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
.
765 766 767 768 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 765 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.
Minimum permissions
You must have the following permissions to remove a resource that's
been associated with an application using the APPLY_APPLICATION_TAG
option for AssociateResource.
tag:GetResources
tag:UntagResources
You must also have the following permissions if you don't use the
AWSServiceCatalogAppRegistryFullAccess
policy. For more information,
see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry
Administrator Guide.
resource-groups:DisassociateResource
cloudformation:UpdateStack
cloudformation:DescribeStacks
838 839 840 841 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 838 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 by its ARN, ID, or name (which is unique
within one account in one region at a given point in time). Specify by
ARN or 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.
896 897 898 899 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 896 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.
964 965 966 967 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 964 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 by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.
1011 1012 1013 1014 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1011 def get_attribute_group(params = {}, = {}) req = build_request(:get_attribute_group, params) req.send_request() end |
#get_configuration(params = {}) ⇒ Types::GetConfigurationResponse
Retrieves a TagKey
configuration from an account.
1030 1031 1032 1033 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1030 def get_configuration(params = {}, = {}) req = build_request(:get_configuration, 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.
1075 1076 1077 1078 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1075 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.
1120 1121 1122 1123 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1120 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 of the resources that are associated with the specified application. Results are paginated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1177 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.
1224 1225 1226 1227 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1224 def list_attribute_groups(params = {}, = {}) req = build_request(:list_attribute_groups, params) req.send_request() end |
#list_attribute_groups_for_application(params = {}) ⇒ Types::ListAttributeGroupsForApplicationResponse
Lists the details of all attribute groups associated with a specific application. The results display in pages.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1272 1273 1274 1275 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1272 def list_attribute_groups_for_application(params = {}, = {}) req = build_request(:list_attribute_groups_for_application, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all of the tags on the resource.
1301 1302 1303 1304 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1301 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_configuration(params = {}) ⇒ Struct
Associates a TagKey
configuration to an account.
1327 1328 1329 1330 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1327 def put_configuration(params = {}, = {}) req = build_request(:put_configuration, 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.
1370 1371 1372 1373 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1370 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.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1404 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.
1432 1433 1434 1435 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1432 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.
1479 1480 1481 1482 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1479 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.
1532 1533 1534 1535 |
# File 'gems/aws-sdk-appregistry/lib/aws-sdk-appregistry/client.rb', line 1532 def update_attribute_group(params = {}, = {}) req = build_request(:update_attribute_group, params) req.send_request() end |