Client

appregistry

R Documentation

AWS Service Catalog App Registry¶

Description¶

Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.

Usage¶

appregistry(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- appregistry(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

associate_attribute_group: Associates an attribute group with an application to augment the application's metadata with the group's attributes
associate_resource: Associates a resource with an application
create_application: Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions
create_attribute_group: Creates a new attribute group as a container for user-defined attributes
delete_application: Deletes an application that is specified either by its application ID, name, or ARN
delete_attribute_group: Deletes an attribute group, specified either by its attribute group ID, name, or ARN
disassociate_attribute_group: Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata
disassociate_resource: Disassociates a resource from application
get_application: Retrieves metadata information about one of your applications
get_associated_resource: Gets the resource associated with the application
get_attribute_group: Retrieves an attribute group by its ARN, ID, or name
get_configuration: Retrieves a TagKey configuration from an account
list_applications: Retrieves a list of all of your applications
list_associated_attribute_groups: Lists all attribute groups that are associated with specified application
list_associated_resources: Lists all of the resources that are associated with the specified application
list_attribute_groups: Lists all attribute groups which you have access to
list_attribute_groups_for_application: Lists the details of all attribute groups associated with a specific application
list_tags_for_resource: Lists all of the tags on the resource
put_configuration: Associates a TagKey configuration to an account
sync_resource: Syncs the resource with current AppRegistry records
tag_resource: Assigns one or more tags (key-value pairs) to the specified resource
untag_resource: Removes tags from a resource
update_application: Updates an existing application with new attributes
update_attribute_group: Updates an existing attribute group with new details

Examples¶

## Not run: 
svc <- appregistry()
svc$associate_attribute_group(
  Foo = 123
)

## End(Not run)