RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/APIGateway/Client.html below:

Client — AWS SDK for Ruby V2

Instance Method Details #create_usage_plan(options = {}) ⇒ Types::UsagePlan

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

#create_usage_plan_key(options = {}) ⇒ Types::UsagePlanKey

Creates a usage plan key for adding an existing API key to a usage plan.

#create_vpc_link(options = {}) ⇒ Types::VpcLink

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

#delete_api_key(options = {}) ⇒ Struct #delete_authorizer(options = {}) ⇒ Struct #delete_base_path_mapping(options = {}) ⇒ Struct #delete_client_certificate(options = {}) ⇒ Struct #delete_deployment(options = {}) ⇒ Struct

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

#delete_documentation_part(options = {}) ⇒ Struct #delete_documentation_version(options = {}) ⇒ Struct #delete_domain_name(options = {}) ⇒ Struct #delete_gateway_response(options = {}) ⇒ Struct

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

#delete_integration(options = {}) ⇒ Struct

Represents a delete integration.

#delete_integration_response(options = {}) ⇒ Struct

Represents a delete integration response.

#delete_method(options = {}) ⇒ Struct

Deletes an existing Method resource.

#delete_method_response(options = {}) ⇒ Struct #delete_model(options = {}) ⇒ Struct #delete_request_validator(options = {}) ⇒ Struct #delete_resource(options = {}) ⇒ Struct #delete_rest_api(options = {}) ⇒ Struct

Deletes the specified API.

#delete_stage(options = {}) ⇒ Struct

Deletes a Stage resource.

#delete_usage_plan(options = {}) ⇒ Struct

Deletes a usage plan of a given plan Id.

#delete_usage_plan_key(options = {}) ⇒ Struct

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

#delete_vpc_link(options = {}) ⇒ Struct

Deletes an existing VpcLink of a specified identifier.

#flush_stage_authorizers_cache(options = {}) ⇒ Struct

Flushes all authorizer cache entries on a stage.

#flush_stage_cache(options = {}) ⇒ Struct #get_domain_name(options = {}) ⇒ Types::DomainName

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

#get_model(options = {}) ⇒ Types::Model

Describes an existing model defined for a RestApi resource.

#get_model_template(options = {}) ⇒ Types::Template

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

#get_resource(options = {}) ⇒ Types::Resource

Lists information about a resource.

#get_stages(options = {}) ⇒ Types::Stages

Gets information about one or more Stage resources.

#get_tags(options = {}) ⇒ Types::Tags

Gets the Tags collection for a given resource.

#get_usage(options = {}) ⇒ Types::Usage

Gets the usage data of a usage plan in a specified time interval.

#get_usage_plan(options = {}) ⇒ Types::UsagePlan

Gets a usage plan of a given plan identifier.

#get_usage_plan_key(options = {}) ⇒ Types::UsagePlanKey

Gets a usage plan key of a given key identifier.

#get_usage_plan_keys(options = {}) ⇒ Types::UsagePlanKeys

Gets all the usage plan keys representing the API keys added to a specified usage plan.

#get_usage_plans(options = {}) ⇒ Types::UsagePlans

Gets all the usage plans of the caller's account.

#get_vpc_link(options = {}) ⇒ Types::VpcLink

Gets a specified VPC link under the caller's account in a region.

#get_vpc_links(options = {}) ⇒ Types::VpcLinks

Gets the VpcLinks collection under the caller's account in a selected region.

#import_api_keys(options = {}) ⇒ Types::ApiKeyIds

Import API keys from an external source, such as a CSV-formatted file.

#import_rest_api(options = {}) ⇒ Types::RestApi

A feature of the API Gateway control service for creating a new API from an external API definition file.

#put_rest_api(options = {}) ⇒ Types::RestApi

A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

#tag_resource(options = {}) ⇒ Struct

Adds or updates a tag on a given resource.

#untag_resource(options = {}) ⇒ Struct

Removes a tag from a given resource.

#update_model(options = {}) ⇒ Types::Model

Changes information about a model.

#update_rest_api(options = {}) ⇒ Types::RestApi

Changes information about the specified API.

#update_stage(options = {}) ⇒ Types::Stage

Changes information about a Stage resource.

#update_usage(options = {}) ⇒ Types::Usage

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

#update_usage_plan(options = {}) ⇒ Types::UsagePlan

Updates a usage plan of a given plan Id.

#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

#waiter_names ⇒ Array<Symbol>

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

Waiter Name Client Method Default Delay: Default Max Attempts:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4