You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppRegistry::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Service Catalog App Registry. To construct a client, you need to configure a :region and :credentials.

appregistry = Aws::AppRegistry::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::AppRegistry::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::AppRegistry::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#associate_attribute_group(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.associate_attribute_group({
  application: "ApplicationSpecifier", # required
  attribute_group: "AttributeGroupSpecifier", # required
})

Response structure


resp.application_arn #=> String
resp.attribute_group_arn #=> String

Options Hash (options):

  • :application (required, String) —

    The name or ID of the application.

  • :attribute_group (required, String) —

    The name or ID of the attribute group that holds the attributes to describe the application.

Returns:

See Also:

#associate_resource(options = {}) ⇒ Types::AssociateResourceResponse

Associates a resource with an application. Both the resource and the application can be specified either by ID or name.

Examples:

Request syntax with placeholder values


resp = client.associate_resource({
  application: "ApplicationSpecifier", # required
  resource_type: "CFN_STACK", # required, accepts CFN_STACK
  resource: "ResourceSpecifier", # required
})

Response structure


resp.application_arn #=> String
resp.resource_arn #=> String

Options Hash (options):

  • :application (required, String) —

    The name or ID of the application.

  • :resource_type (required, String) —

    The type of resource of which the application will be associated.

  • :resource (required, String) —

    The name or ID of the resource of which the application will be associated.

Returns:

See Also:

#create_application(options = {}) ⇒ Types::CreateApplicationResponse

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

Examples:

Request syntax with placeholder values


resp = client.create_application({
  name: "Name", # required
  description: "Description",
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken", # required
})

Response structure


resp.application.id #=> String
resp.application.arn #=> String
resp.application.name #=> String
resp.application.description #=> String
resp.application.creation_time #=> Time
resp.application.last_update_time #=> Time
resp.application.tags #=> Hash
resp.application.tags["TagKey"] #=> String

Options Hash (options):

  • :name (required, String) —

    The name of the application. The name must be unique in the region in which you are creating the application.

  • :description (String) —

    The description of the application.

  • :tags (Hash<String,String>) —

    Key-value pairs you can use to associate with the application.

  • :client_token (required, String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.

Returns:

See Also:

#create_attribute_group(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.create_attribute_group({
  name: "Name", # required
  description: "Description",
  attributes: "Attributes", # required
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken", # required
})

Response structure


resp.attribute_group.id #=> String
resp.attribute_group.arn #=> String
resp.attribute_group.name #=> String
resp.attribute_group.description #=> String
resp.attribute_group.creation_time #=> Time
resp.attribute_group.last_update_time #=> Time
resp.attribute_group.tags #=> Hash
resp.attribute_group.tags["TagKey"] #=> String

Options Hash (options):

  • :name (required, String) —

    The name of the attribute group.

  • :description (String) —

    The description of the attribute group that the user provides.

  • :attributes (required, String) —

    A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.

  • :tags (Hash<String,String>) —

    Key-value pairs you can use to associate with the attribute group.

  • :client_token (required, String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.

Returns:

See Also:

#delete_application(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  application: "ApplicationSpecifier", # required
})

Response structure


resp.application.id #=> String
resp.application.arn #=> String
resp.application.name #=> String
resp.application.description #=> String
resp.application.creation_time #=> Time
resp.application.last_update_time #=> Time

Options Hash (options):

  • :application (required, String) —

    The name or ID of the application.

Returns:

See Also:

#delete_attribute_group(options = {}) ⇒ Types::DeleteAttributeGroupResponse

Deletes an attribute group, specified either by its attribute group ID or name.

Examples:

Request syntax with placeholder values


resp = client.delete_attribute_group({
  attribute_group: "AttributeGroupSpecifier", # required
})

Response structure


resp.attribute_group.id #=> String
resp.attribute_group.arn #=> String
resp.attribute_group.name #=> String
resp.attribute_group.description #=> String
resp.attribute_group.creation_time #=> Time
resp.attribute_group.last_update_time #=> Time

Options Hash (options):

  • :attribute_group (required, String) —

    The name or ID of the attribute group that holds the attributes to describe the application.

Returns:

See Also:

#disassociate_attribute_group(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.disassociate_attribute_group({
  application: "ApplicationSpecifier", # required
  attribute_group: "AttributeGroupSpecifier", # required
})

Response structure


resp.application_arn #=> String
resp.attribute_group_arn #=> String

Options Hash (options):

  • :application (required, String) —

    The name or ID of the application.

  • :attribute_group (required, String) —

    The name or ID of the attribute group that holds the attributes to describe the application.

Returns:

See Also:

#disassociate_resource(options = {}) ⇒ Types::DisassociateResourceResponse

Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.

Examples:

Request syntax with placeholder values


resp = client.disassociate_resource({
  application: "ApplicationSpecifier", # required
  resource_type: "CFN_STACK", # required, accepts CFN_STACK
  resource: "ResourceSpecifier", # required
})

Response structure


resp.application_arn #=> String
resp.resource_arn #=> String

Options Hash (options):

  • :application (required, String) —

    The name or ID of the application.

  • :resource_type (required, String) —

    The type of the resource that is being disassociated.

  • :resource (required, String) —

    The name or ID of the resource.

Returns:

See Also:

#get_application(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.get_application({
  application: "ApplicationSpecifier", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.creation_time #=> Time
resp.last_update_time #=> Time
resp.associated_resource_count #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Options Hash (options):

  • :application (required, String) —

    The name or ID of the application.

Returns:

See Also:

#get_attribute_group(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.get_attribute_group({
  attribute_group: "AttributeGroupSpecifier", # required
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.attributes #=> String
resp.creation_time #=> Time
resp.last_update_time #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Options Hash (options):

  • :attribute_group (required, String) —

    The name or ID of the attribute group that holds the attributes to describe the application.

Returns:

See Also:

#list_applications(options = {}) ⇒ Types::ListApplicationsResponse

Retrieves a list of all of your applications. Results are paginated.

Examples:

Request syntax with placeholder values


resp = client.list_applications({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.applications #=> Array
resp.applications[0].id #=> String
resp.applications[0].arn #=> String
resp.applications[0].name #=> String
resp.applications[0].description #=> String
resp.applications[0].creation_time #=> Time
resp.applications[0].last_update_time #=> Time
resp.next_token #=> String

Options Hash (options):

  • :next_token (String) —

    The token to use to get the next page of results after a previous API call.

  • :max_results (Integer) —

    The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

Returns:

See Also:

#list_associated_attribute_groups(options = {}) ⇒ Types::ListAssociatedAttributeGroupsResponse

Lists all attribute groups that are associated with specified application. Results are paginated.

Examples:

Request syntax with placeholder values


resp = client.list_associated_attribute_groups({
  application: "ApplicationSpecifier", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.attribute_groups #=> Array
resp.attribute_groups[0] #=> String
resp.next_token #=> String

Options Hash (options):

  • :application (required, String) —

    The name or ID of the application.

  • :next_token (String) —

    The token to use to get the next page of results after a previous API call.

  • :max_results (Integer) —

    The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

Returns:

See Also:

#list_associated_resources(options = {}) ⇒ Types::ListAssociatedResourcesResponse

Lists all resources that are associated with specified application. Results are paginated.

Examples:

Request syntax with placeholder values


resp = client.list_associated_resources({
  application: "ApplicationSpecifier", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.resources #=> Array
resp.resources[0].name #=> String
resp.resources[0].arn #=> String
resp.next_token #=> String

Options Hash (options):

  • :application (required, String) —

    The name or ID of the application.

  • :next_token (String) —

    The token to use to get the next page of results after a previous API call.

  • :max_results (Integer) —

    The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

Returns:

See Also:

#list_attribute_groups(options = {}) ⇒ Types::ListAttributeGroupsResponse

Lists all attribute groups which you have access to. Results are paginated.

Examples:

Request syntax with placeholder values


resp = client.list_attribute_groups({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.attribute_groups #=> Array
resp.attribute_groups[0].id #=> String
resp.attribute_groups[0].arn #=> String
resp.attribute_groups[0].name #=> String
resp.attribute_groups[0].description #=> String
resp.attribute_groups[0].creation_time #=> Time
resp.attribute_groups[0].last_update_time #=> Time
resp.next_token #=> String

Options Hash (options):

  • :next_token (String) —

    The token to use to get the next page of results after a previous API call.

  • :max_results (Integer) —

    The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

Returns:

See Also:

#update_application(options = {}) ⇒ Types::UpdateApplicationResponse

Updates an existing application with new attributes.

Examples:

Request syntax with placeholder values


resp = client.update_application({
  application: "ApplicationSpecifier", # required
  name: "Name",
  description: "Description",
})

Response structure


resp.application.id #=> String
resp.application.arn #=> String
resp.application.name #=> String
resp.application.description #=> String
resp.application.creation_time #=> Time
resp.application.last_update_time #=> Time
resp.application.tags #=> Hash
resp.application.tags["TagKey"] #=> String

Options Hash (options):

  • :application (required, String) —

    The name or ID of the application that will be updated.

  • :name (String) —

    The new name of the application. The name must be unique in the region in which you are updating the application.

  • :description (String) —

    The new description of the application.

Returns:

See Also:

#update_attribute_group(options = {}) ⇒ Types::UpdateAttributeGroupResponse

Updates an existing attribute group with new details.

Examples:

Request syntax with placeholder values


resp = client.update_attribute_group({
  attribute_group: "AttributeGroupSpecifier", # required
  name: "Name",
  description: "Description",
  attributes: "Attributes",
})

Response structure


resp.attribute_group.id #=> String
resp.attribute_group.arn #=> String
resp.attribute_group.name #=> String
resp.attribute_group.description #=> String
resp.attribute_group.creation_time #=> Time
resp.attribute_group.last_update_time #=> Time
resp.attribute_group.tags #=> Hash
resp.attribute_group.tags["TagKey"] #=> String

Options Hash (options):

  • :attribute_group (required, String) —

    The name or ID of the attribute group that holds the attributes to describe the application.

  • :name (String) —

    The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group.

  • :description (String) —

    The description of the attribute group that the user provides.

  • :attributes (String) —

    A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {}) —

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.