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

Class: Aws::APIGateway::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#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(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



144
145
146
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 144

def initialize(*args)
  super
end

Instance Method Details

#create_api_key(params = {}) ⇒ Types::ApiKey

Create an ApiKey resource.

[AWS CLI][1]

Examples:

Request syntax with placeholder values


resp = client.create_api_key({
  name: "String",
  description: "String",
  enabled: false,
  generate_distinct_id: false,
  value: "String",
  stage_keys: [
    {
      rest_api_id: "String",
      stage_name: "String",
    },
  ],
  customer_id: "String",
})

Response structure


resp.id #=> String
resp.value #=> String
resp.name #=> String
resp.customer_id #=> String
resp.description #=> String
resp.enabled #=> Boolean
resp.created_date #=> Time
resp.last_updated_date #=> Time
resp.stage_keys #=> Array
resp.stage_keys[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String)

    The name of the ApiKey.

  • :description (String)

    The description of the ApiKey.

  • :enabled (Boolean)

    Specifies whether the ApiKey can be used by callers.

  • :generate_distinct_id (Boolean)

    Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

  • :value (String)

    Specifies a value of the API key.

  • :stage_keys (Array<Types::StageKey>)

    DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

  • :customer_id (String)

    An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Returns:



228
229
230
231
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 228

def create_api_key(params = {}, options = {})
  req = build_request(:create_api_key, params)
  req.send_request(options)
end

#create_authorizer(params = {}) ⇒ Types::Authorizer

Adds a new Authorizer resource to an existing RestApi resource.

[AWS CLI][1]

Examples:

Request syntax with placeholder values


resp = client.create_authorizer({
  rest_api_id: "String", # required
  name: "String", # required
  type: "TOKEN", # required, accepts TOKEN, COGNITO_USER_POOLS
  provider_arns: ["ProviderARN"],
  auth_type: "String",
  authorizer_uri: "String",
  authorizer_credentials: "String",
  identity_source: "String", # required
  identity_validation_expression: "String",
  authorizer_result_ttl_in_seconds: 1,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
resp.provider_arns #=> Array
resp.provider_arns[0] #=> String
resp.auth_type #=> String
resp.authorizer_uri #=> String
resp.authorizer_credentials #=> String
resp.identity_source #=> String
resp.identity_validation_expression #=> String
resp.authorizer_result_ttl_in_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :name (required, String)

    [Required] The name of the authorizer.

  • :type (required, String)

    [Required] The type of the authorizer.

  • :provider_arns (Array<String>)

    A list of the Cognito Your User Pool authorizer's provider ARNs.

  • :auth_type (String)

    Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

  • :authorizer_uri (String)

    [Required] Specifies the authorizer's Uniform Resource Identifier (URI).

  • :authorizer_credentials (String)

    Specifies the credentials required for the authorizer, if any.

  • :identity_source (required, String)

    [Required] The source of the identity in an incoming request.

  • :identity_validation_expression (String)

    A validation expression for the incoming identity.

  • :authorizer_result_ttl_in_seconds (Integer)

    The TTL of cached authorizer results.

Returns:



319
320
321
322
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 319

def create_authorizer(params = {}, options = {})
  req = build_request(:create_authorizer, params)
  req.send_request(options)
end

#create_base_path_mapping(params = {}) ⇒ Types::BasePathMapping

Creates a new BasePathMapping resource.

Examples:

Request syntax with placeholder values


resp = client.create_base_path_mapping({
  domain_name: "String", # required
  base_path: "String",
  rest_api_id: "String", # required
  stage: "String",
})

Response structure


resp.base_path #=> String
resp.rest_api_id #=> String
resp.stage #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The domain name of the BasePathMapping resource to create.

  • :base_path (String)

    The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :stage (String)

    The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.

Returns:



366
367
368
369
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 366

def create_base_path_mapping(params = {}, options = {})
  req = build_request(:create_base_path_mapping, params)
  req.send_request(options)
end

#create_deployment(params = {}) ⇒ Types::Deployment

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Examples:

Request syntax with placeholder values


resp = client.create_deployment({
  rest_api_id: "String", # required
  stage_name: "String",
  stage_description: "String",
  description: "String",
  cache_cluster_enabled: false,
  cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
  variables: {
    "String" => "String",
  },
})

Response structure


resp.id #=> String
resp.description #=> String
resp.created_date #=> Time
resp.api_summary #=> Hash
resp.api_summary["String"] #=> Hash
resp.api_summary["String"]["String"].authorization_type #=> String
resp.api_summary["String"]["String"].api_key_required #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :stage_name (String)

    The name of the Stage resource for the Deployment resource to create.

  • :stage_description (String)

    The description of the Stage resource for the Deployment resource to create.

  • :description (String)

    The description for the Deployment resource to create.

  • :cache_cluster_enabled (Boolean)

    Enables a cache cluster for the Stage resource specified in the input.

  • :cache_cluster_size (String)

    Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

  • :variables (Hash<String,String>)

    A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Returns:



433
434
435
436
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 433

def create_deployment(params = {}, options = {})
  req = build_request(:create_deployment, params)
  req.send_request(options)
end

#create_documentation_part(params = {}) ⇒ Types::DocumentationPart

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.create_documentation_part({
  rest_api_id: "String", # required
  location: { # required
    type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
    path: "String",
    method: "String",
    status_code: "DocumentationPartLocationStatusCode",
    name: "String",
  },
  properties: "String", # required
})

Response structure


resp.id #=> String
resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
resp.location.path #=> String
resp.location.method #=> String
resp.location.status_code #=> String
resp.location.name #=> String
resp.properties #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :location (required, Types::DocumentationPartLocation)

    [Required] The location of the targeted API entity of the to-be-created documentation part.

  • :properties (required, String)

    [Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value pairs can be exported and, hence, published.

Returns:



483
484
485
486
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 483

def create_documentation_part(params = {}, options = {})
  req = build_request(:create_documentation_part, params)
  req.send_request(options)
end

#create_documentation_version(params = {}) ⇒ Types::DocumentationVersion

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.create_documentation_version({
  rest_api_id: "String", # required
  documentation_version: "String", # required
  stage_name: "String",
  description: "String",
})

Response structure


resp.version #=> String
resp.created_date #=> Time
resp.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :documentation_version (required, String)

    [Required] The version identifier of the new snapshot.

  • :stage_name (String)

    The stage name to be associated with the new documentation snapshot.

  • :description (String)

    A description about the new documentation snapshot.

Returns:



523
524
525
526
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 523

def create_documentation_version(params = {}, options = {})
  req = build_request(:create_documentation_version, params)
  req.send_request(options)
end

#create_domain_name(params = {}) ⇒ Types::DomainName

Creates a new domain name.

Examples:

Request syntax with placeholder values


resp = client.create_domain_name({
  domain_name: "String", # required
  certificate_name: "String",
  certificate_body: "String",
  certificate_private_key: "String",
  certificate_chain: "String",
  certificate_arn: "String",
})

Response structure


resp.domain_name #=> String
resp.certificate_name #=> String
resp.certificate_arn #=> String
resp.certificate_upload_date #=> Time
resp.distribution_domain_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) — default: Required

    The name of the DomainName resource.

  • :certificate_name (String)

    The user-friendly name of the certificate.

  • :certificate_body (String)

    [Deprecated] The body of the server certificate provided by your certificate authority.

  • :certificate_private_key (String)

    [Deprecated] Your certificate's private key.

  • :certificate_chain (String)

    [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

  • :certificate_arn (String)

    The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source.

Returns:



585
586
587
588
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 585

def create_domain_name(params = {}, options = {})
  req = build_request(:create_domain_name, params)
  req.send_request(options)
end

#create_model(params = {}) ⇒ Types::Model

Adds a new Model resource to an existing RestApi resource.

Examples:

Request syntax with placeholder values


resp = client.create_model({
  rest_api_id: "String", # required
  name: "String", # required
  description: "String",
  schema: "String",
  content_type: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.schema #=> String
resp.content_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The RestApi identifier under which the Model will be created.

  • :name (required, String)

    The name of the model.

  • :description (String)

    The description of the model.

  • :schema (String)

    The schema for the model. For application/json models, this should be JSON-schema draft v4 model.

  • :content_type (required, String)

    The content-type for the model.

Returns:



640
641
642
643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 640

def create_model(params = {}, options = {})
  req = build_request(:create_model, params)
  req.send_request(options)
end

#create_request_validator(params = {}) ⇒ Types::RequestValidator

Creates a ReqeustValidator of a given RestApi.

Examples:

Request syntax with placeholder values


resp = client.create_request_validator({
  rest_api_id: "String", # required
  name: "String",
  validate_request_body: false,
  validate_request_parameters: false,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.validate_request_body #=> Boolean
resp.validate_request_parameters #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :name (String)

    The name of the to-be-created RequestValidator.

  • :validate_request_body (Boolean)

    A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).

  • :validate_request_parameters (Boolean)

    A Boolean flag to indicate whether to validate request parameters, true, or not false.

Returns:



687
688
689
690
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 687

def create_request_validator(params = {}, options = {})
  req = build_request(:create_request_validator, params)
  req.send_request(options)
end

#create_resource(params = {}) ⇒ Types::Resource

Creates a Resource resource.

Examples:

Request syntax with placeholder values


resp = client.create_resource({
  rest_api_id: "String", # required
  parent_id: "String", # required
  path_part: "String", # required
})

Response structure


resp.id #=> String
resp.parent_id #=> String
resp.path_part #=> String
resp.path #=> String
resp.resource_methods #=> Hash
resp.resource_methods["String"].http_method #=> String
resp.resource_methods["String"].authorization_type #=> String
resp.resource_methods["String"].authorizer_id #=> String
resp.resource_methods["String"].api_key_required #=> Boolean
resp.resource_methods["String"].request_validator_id #=> String
resp.resource_methods["String"].operation_name #=> String
resp.resource_methods["String"].request_parameters #=> Hash
resp.resource_methods["String"].request_parameters["String"] #=> Boolean
resp.resource_methods["String"].request_models #=> Hash
resp.resource_methods["String"].request_models["String"] #=> String
resp.resource_methods["String"].method_responses #=> Hash
resp.resource_methods["String"].method_responses["String"].status_code #=> String
resp.resource_methods["String"].method_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_responses["String"].response_parameters["String"] #=> Boolean
resp.resource_methods["String"].method_responses["String"].response_models #=> Hash
resp.resource_methods["String"].method_responses["String"].response_models["String"] #=> String
resp.resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.resource_methods["String"].method_integration.http_method #=> String
resp.resource_methods["String"].method_integration.uri #=> String
resp.resource_methods["String"].method_integration.credentials #=> String
resp.resource_methods["String"].method_integration.request_parameters #=> Hash
resp.resource_methods["String"].method_integration.request_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.request_templates #=> Hash
resp.resource_methods["String"].method_integration.request_templates["String"] #=> String
resp.resource_methods["String"].method_integration.passthrough_behavior #=> String
resp.resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.resource_methods["String"].method_integration.cache_namespace #=> String
resp.resource_methods["String"].method_integration.cache_key_parameters #=> Array
resp.resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
resp.resource_methods["String"].method_integration.integration_responses #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :parent_id (required, String)

    The parent resource's identifier.

  • :path_part (required, String)

    The last path segment for this resource.

Returns:



766
767
768
769
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 766

def create_resource(params = {}, options = {})
  req = build_request(:create_resource, params)
  req.send_request(options)
end

#create_rest_api(params = {}) ⇒ Types::RestApi

Creates a new RestApi resource.

Examples:

Request syntax with placeholder values


resp = client.create_rest_api({
  name: "String", # required
  description: "String",
  version: "String",
  clone_from: "String",
  binary_media_types: ["String"],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String
resp.binary_media_types #=> Array
resp.binary_media_types[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the RestApi.

  • :description (String)

    The description of the RestApi.

  • :version (String)

    A version identifier for the API.

  • :clone_from (String)

    The ID of the RestApi that you want to clone from.

  • :binary_media_types (Array<String>)

    The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Returns:



823
824
825
826
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 823

def create_rest_api(params = {}, options = {})
  req = build_request(:create_rest_api, params)
  req.send_request(options)
end

#create_stage(params = {}) ⇒ Types::Stage

Creates a new Stage resource that references a pre-existing Deployment for the API.

Examples:

Request syntax with placeholder values


resp = client.create_stage({
  rest_api_id: "String", # required
  stage_name: "String", # required
  deployment_id: "String", # required
  description: "String",
  cache_cluster_enabled: false,
  cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
  variables: {
    "String" => "String",
  },
  documentation_version: "String",
})

Response structure


resp.deployment_id #=> String
resp.client_certificate_id #=> String
resp.stage_name #=> String
resp.description #=> String
resp.cache_cluster_enabled #=> Boolean
resp.cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
resp.cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
resp.method_settings #=> Hash
resp.method_settings["String"].metrics_enabled #=> Boolean
resp.method_settings["String"].logging_level #=> String
resp.method_settings["String"].data_trace_enabled #=> Boolean
resp.method_settings["String"].throttling_burst_limit #=> Integer
resp.method_settings["String"].throttling_rate_limit #=> Float
resp.method_settings["String"].caching_enabled #=> Boolean
resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.method_settings["String"].cache_data_encrypted #=> Boolean
resp.method_settings["String"].require_authorization_for_cache_control #=> Boolean
resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
resp.variables #=> Hash
resp.variables["String"] #=> String
resp.documentation_version #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :stage_name (required, String)

    The name for the Stage resource.

  • :deployment_id (required, String)

    The identifier of the Deployment resource for the Stage resource.

  • :description (String)

    The description of the Stage resource.

  • :cache_cluster_enabled (Boolean)

    Whether cache clustering is enabled for the stage.

  • :cache_cluster_size (String)

    The stage's cache cluster size.

  • :variables (Hash<String,String>)

    A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

  • :documentation_version (String)

    The version of the associated API documentation.

Returns:



915
916
917
918
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 915

def create_stage(params = {}, options = {})
  req = build_request(:create_stage, params)
  req.send_request(options)
end

#create_usage_plan(params = {}) ⇒ Types::UsagePlan

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

Examples:

Request syntax with placeholder values


resp = client.create_usage_plan({
  name: "String", # required
  description: "String",
  api_stages: [
    {
      api_id: "String",
      stage: "String",
    },
  ],
  throttle: {
    burst_limit: 1,
    rate_limit: 1.0,
  },
  quota: {
    limit: 1,
    offset: 1,
    period: "DAY", # accepts DAY, WEEK, MONTH
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.api_stages #=> Array
resp.api_stages[0].api_id #=> String
resp.api_stages[0].stage #=> String
resp.throttle.burst_limit #=> Integer
resp.throttle.rate_limit #=> Float
resp.quota.limit #=> Integer
resp.quota.offset #=> Integer
resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
resp.product_code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the usage plan.

  • :description (String)

    The description of the usage plan.

  • :api_stages (Array<Types::ApiStage>)

    The associated API stages of the usage plan.

  • :throttle (Types::ThrottleSettings)

    The throttling limits of the usage plan.

  • :quota (Types::QuotaSettings)

    The quota of the usage plan.

Returns:



987
988
989
990
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 987

def create_usage_plan(params = {}, options = {})
  req = build_request(:create_usage_plan, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.create_usage_plan_key({
  usage_plan_id: "String", # required
  key_id: "String", # required
  key_type: "String", # required
})

Response structure


resp.id #=> String
resp.type #=> String
resp.value #=> String
resp.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String)

    The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

  • :key_id (required, String)

    The identifier of a UsagePlanKey resource for a plan customer.

  • :key_type (required, String)

    The type of a UsagePlanKey resource for a plan customer.

Returns:



1030
1031
1032
1033
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1030

def create_usage_plan_key(params = {}, options = {})
  req = build_request(:create_usage_plan_key, params)
  req.send_request(options)
end

#delete_api_key(params = {}) ⇒ Struct

Deletes the ApiKey resource.

Examples:

Request syntax with placeholder values


resp = client.delete_api_key({
  api_key: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :api_key (required, String)

    The identifier of the ApiKey resource to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1050
1051
1052
1053
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1050

def delete_api_key(params = {}, options = {})
  req = build_request(:delete_api_key, params)
  req.send_request(options)
end

#delete_authorizer(params = {}) ⇒ Struct

Deletes an existing Authorizer resource.

[AWS CLI][1]

Examples:

Request syntax with placeholder values


resp = client.delete_authorizer({
  rest_api_id: "String", # required
  authorizer_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :authorizer_id (required, String)

    The identifier of the Authorizer resource.

Returns:

  • (Struct)

    Returns an empty response.



1082
1083
1084
1085
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1082

def delete_authorizer(params = {}, options = {})
  req = build_request(:delete_authorizer, params)
  req.send_request(options)
end

#delete_base_path_mapping(params = {}) ⇒ Struct

Deletes the BasePathMapping resource.

Examples:

Request syntax with placeholder values


resp = client.delete_base_path_mapping({
  domain_name: "String", # required
  base_path: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The domain name of the BasePathMapping resource to delete.

  • :base_path (required, String)

    The base path name of the BasePathMapping resource to delete.

Returns:

  • (Struct)

    Returns an empty response.



1106
1107
1108
1109
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1106

def delete_base_path_mapping(params = {}, options = {})
  req = build_request(:delete_base_path_mapping, params)
  req.send_request(options)
end

#delete_client_certificate(params = {}) ⇒ Struct

Deletes the ClientCertificate resource.

Examples:

Request syntax with placeholder values


resp = client.delete_client_certificate({
  client_certificate_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_certificate_id (required, String)

    The identifier of the ClientCertificate resource to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1126
1127
1128
1129
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1126

def delete_client_certificate(params = {}, options = {})
  req = build_request(:delete_client_certificate, params)
  req.send_request(options)
end

#delete_deployment(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_deployment({
  rest_api_id: "String", # required
  deployment_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :deployment_id (required, String)

    The identifier of the Deployment resource to delete.

Returns:

  • (Struct)

    Returns an empty response.



1151
1152
1153
1154
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1151

def delete_deployment(params = {}, options = {})
  req = build_request(:delete_deployment, params)
  req.send_request(options)
end

#delete_documentation_part(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.delete_documentation_part({
  rest_api_id: "String", # required
  documentation_part_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :documentation_part_id (required, String)

    [Required] The identifier of the to-be-deleted documentation part.

Returns:

  • (Struct)

    Returns an empty response.



1173
1174
1175
1176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1173

def delete_documentation_part(params = {}, options = {})
  req = build_request(:delete_documentation_part, params)
  req.send_request(options)
end

#delete_documentation_version(params = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.delete_documentation_version({
  rest_api_id: "String", # required
  documentation_version: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :documentation_version (required, String)

    [Required] The version identifier of a to-be-deleted documentation snapshot.

Returns:

  • (Struct)

    Returns an empty response.



1196
1197
1198
1199
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1196

def delete_documentation_version(params = {}, options = {})
  req = build_request(:delete_documentation_version, params)
  req.send_request(options)
end

#delete_domain_name(params = {}) ⇒ Struct

Deletes the DomainName resource.

Examples:

Request syntax with placeholder values


resp = client.delete_domain_name({
  domain_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the DomainName resource to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1216
1217
1218
1219
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1216

def delete_domain_name(params = {}, options = {})
  req = build_request(:delete_domain_name, params)
  req.send_request(options)
end

#delete_gateway_response(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_gateway_response({
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :response_type (required, String)

    The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPES

Returns:

  • (Struct)

    Returns an empty response.



1261
1262
1263
1264
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1261

def delete_gateway_response(params = {}, options = {})
  req = build_request(:delete_gateway_response, params)
  req.send_request(options)
end

#delete_integration(params = {}) ⇒ Struct

Represents a delete integration.

Examples:

Request syntax with placeholder values


resp = client.delete_integration({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    Specifies a delete integration request's resource identifier.

  • :http_method (required, String)

    Specifies a delete integration request's HTTP method.

Returns:

  • (Struct)

    Returns an empty response.



1289
1290
1291
1292
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1289

def delete_integration(params = {}, options = {})
  req = build_request(:delete_integration, params)
  req.send_request(options)
end

#delete_integration_response(params = {}) ⇒ Struct

Represents a delete integration response.

Examples:

Request syntax with placeholder values


resp = client.delete_integration_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    Specifies a delete integration response request's resource identifier.

  • :http_method (required, String)

    Specifies a delete integration response request's HTTP method.

  • :status_code (required, String)

    Specifies a delete integration response request's status code.

Returns:

  • (Struct)

    Returns an empty response.



1322
1323
1324
1325
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1322

def delete_integration_response(params = {}, options = {})
  req = build_request(:delete_integration_response, params)
  req.send_request(options)
end

#delete_method(params = {}) ⇒ Struct

Deletes an existing Method resource.

Examples:

Request syntax with placeholder values


resp = client.delete_method({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    The Resource identifier for the Method resource.

  • :http_method (required, String)

    The HTTP verb of the Method resource.

Returns:

  • (Struct)

    Returns an empty response.



1350
1351
1352
1353
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1350

def delete_method(params = {}, options = {})
  req = build_request(:delete_method, params)
  req.send_request(options)
end

#delete_method_response(params = {}) ⇒ Struct

Deletes an existing MethodResponse resource.

Examples:

Request syntax with placeholder values


resp = client.delete_method_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    The Resource identifier for the MethodResponse resource.

  • :http_method (required, String)

    The HTTP verb of the Method resource.

  • :status_code (required, String)

    The status code identifier for the MethodResponse resource.

Returns:

  • (Struct)

    Returns an empty response.



1382
1383
1384
1385
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1382

def delete_method_response(params = {}, options = {})
  req = build_request(:delete_method_response, params)
  req.send_request(options)
end

#delete_model(params = {}) ⇒ Struct

Deletes a model.

Examples:

Request syntax with placeholder values


resp = client.delete_model({
  rest_api_id: "String", # required
  model_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :model_name (required, String)

    The name of the model to delete.

Returns:

  • (Struct)

    Returns an empty response.



1406
1407
1408
1409
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1406

def delete_model(params = {}, options = {})
  req = build_request(:delete_model, params)
  req.send_request(options)
end

#delete_request_validator(params = {}) ⇒ Struct

Deletes a RequestValidator of a given RestApi.

Examples:

Request syntax with placeholder values


resp = client.delete_request_validator({
  rest_api_id: "String", # required
  request_validator_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :request_validator_id (required, String)

    [Required] The identifier of the RequestValidator to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1430
1431
1432
1433
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1430

def delete_request_validator(params = {}, options = {})
  req = build_request(:delete_request_validator, params)
  req.send_request(options)
end

#delete_resource(params = {}) ⇒ Struct

Deletes a Resource resource.

Examples:

Request syntax with placeholder values


resp = client.delete_resource({
  rest_api_id: "String", # required
  resource_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    The identifier of the Resource resource.

Returns:

  • (Struct)

    Returns an empty response.



1454
1455
1456
1457
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1454

def delete_resource(params = {}, options = {})
  req = build_request(:delete_resource, params)
  req.send_request(options)
end

#delete_rest_api(params = {}) ⇒ Struct

Deletes the specified API.

Examples:

Request syntax with placeholder values


resp = client.delete_rest_api({
  rest_api_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

Returns:

  • (Struct)

    Returns an empty response.



1474
1475
1476
1477
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1474

def delete_rest_api(params = {}, options = {})
  req = build_request(:delete_rest_api, params)
  req.send_request(options)
end

#delete_stage(params = {}) ⇒ Struct

Deletes a Stage resource.

Examples:

Request syntax with placeholder values


resp = client.delete_stage({
  rest_api_id: "String", # required
  stage_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :stage_name (required, String)

    The name of the Stage resource to delete.

Returns:

  • (Struct)

    Returns an empty response.



1498
1499
1500
1501
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1498

def delete_stage(params = {}, options = {})
  req = build_request(:delete_stage, params)
  req.send_request(options)
end

#delete_usage_plan(params = {}) ⇒ Struct

Deletes a usage plan of a given plan Id.

Examples:

Request syntax with placeholder values


resp = client.delete_usage_plan({
  usage_plan_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String)

    The Id of the to-be-deleted usage plan.

Returns:

  • (Struct)

    Returns an empty response.



1518
1519
1520
1521
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1518

def delete_usage_plan(params = {}, options = {})
  req = build_request(:delete_usage_plan, params)
  req.send_request(options)
end

#delete_usage_plan_key(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_usage_plan_key({
  usage_plan_id: "String", # required
  key_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String)

    The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

  • :key_id (required, String)

    The Id of the UsagePlanKey resource to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1545
1546
1547
1548
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1545

def delete_usage_plan_key(params = {}, options = {})
  req = build_request(:delete_usage_plan_key, params)
  req.send_request(options)
end

#flush_stage_authorizers_cache(params = {}) ⇒ Struct

Flushes all authorizer cache entries on a stage.

Examples:

Request syntax with placeholder values


resp = client.flush_stage_authorizers_cache({
  rest_api_id: "String", # required
  stage_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :stage_name (required, String)

    The name of the stage to flush.

Returns:

  • (Struct)

    Returns an empty response.



1569
1570
1571
1572
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1569

def flush_stage_authorizers_cache(params = {}, options = {})
  req = build_request(:flush_stage_authorizers_cache, params)
  req.send_request(options)
end

#flush_stage_cache(params = {}) ⇒ Struct

Flushes a stage's cache.

Examples:

Request syntax with placeholder values


resp = client.flush_stage_cache({
  rest_api_id: "String", # required
  stage_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :stage_name (required, String)

    The name of the stage to flush its cache.

Returns:

  • (Struct)

    Returns an empty response.



1593
1594
1595
1596
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1593

def flush_stage_cache(params = {}, options = {})
  req = build_request(:flush_stage_cache, params)
  req.send_request(options)
end

#generate_client_certificate(params = {}) ⇒ Types::ClientCertificate

Generates a ClientCertificate resource.

Examples:

Request syntax with placeholder values


resp = client.generate_client_certificate({
  description: "String",
})

Response structure


resp.client_certificate_id #=> String
resp.description #=> String
resp.pem_encoded_certificate #=> String
resp.created_date #=> Time
resp.expiration_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)

    The description of the ClientCertificate.

Returns:



1627
1628
1629
1630
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1627

def generate_client_certificate(params = {}, options = {})
  req = build_request(:generate_client_certificate, params)
  req.send_request(options)
end

#get_account(params = {}) ⇒ Types::Account

Gets information about the current Account resource.

Examples:

Response structure


resp.cloudwatch_role_arn #=> String
resp.throttle_settings.burst_limit #=> Integer
resp.throttle_settings.rate_limit #=> Float
resp.features #=> Array
resp.features[0] #=> String
resp.api_key_version #=> String

Parameters:

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

    ({})

Returns:



1652
1653
1654
1655
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1652

def (params = {}, options = {})
  req = build_request(:get_account, params)
  req.send_request(options)
end

#get_api_key(params = {}) ⇒ Types::ApiKey

Gets information about the current ApiKey resource.

Examples:

Request syntax with placeholder values


resp = client.get_api_key({
  api_key: "String", # required
  include_value: false,
})

Response structure


resp.id #=> String
resp.value #=> String
resp.name #=> String
resp.customer_id #=> String
resp.description #=> String
resp.enabled #=> Boolean
resp.created_date #=> Time
resp.last_updated_date #=> Time
resp.stage_keys #=> Array
resp.stage_keys[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :api_key (required, String)

    The identifier of the ApiKey resource.

  • :include_value (Boolean)

    A boolean flag to specify whether (true) or not (false) the result contains the key value.

Returns:



1700
1701
1702
1703
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1700

def get_api_key(params = {}, options = {})
  req = build_request(:get_api_key, params)
  req.send_request(options)
end

#get_api_keys(params = {}) ⇒ Types::ApiKeys

Gets information about the current ApiKeys resource.

Examples:

Request syntax with placeholder values


resp = client.get_api_keys({
  position: "String",
  limit: 1,
  name_query: "String",
  customer_id: "String",
  include_values: false,
})

Response structure


resp.warnings #=> Array
resp.warnings[0] #=> String
resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].value #=> String
resp.items[0].name #=> String
resp.items[0].customer_id #=> String
resp.items[0].description #=> String
resp.items[0].enabled #=> Boolean
resp.items[0].created_date #=> Time
resp.items[0].last_updated_date #=> Time
resp.items[0].stage_keys #=> Array
resp.items[0].stage_keys[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page.

  • :name_query (String)

    The name of queried API keys.

  • :customer_id (String)

    The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

  • :include_values (Boolean)

    A boolean flag to specify whether (true) or not (false) the result contains key values.

Returns:



1759
1760
1761
1762
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1759

def get_api_keys(params = {}, options = {})
  req = build_request(:get_api_keys, params)
  req.send_request(options)
end

#get_authorizer(params = {}) ⇒ Types::Authorizer

Describe an existing Authorizer resource.

[AWS CLI][1]

Examples:

Request syntax with placeholder values


resp = client.get_authorizer({
  rest_api_id: "String", # required
  authorizer_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
resp.provider_arns #=> Array
resp.provider_arns[0] #=> String
resp.auth_type #=> String
resp.authorizer_uri #=> String
resp.authorizer_credentials #=> String
resp.identity_source #=> String
resp.identity_validation_expression #=> String
resp.authorizer_result_ttl_in_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :authorizer_id (required, String)

    The identifier of the Authorizer resource.

Returns:



1816
1817
1818
1819
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1816

def get_authorizer(params = {}, options = {})
  req = build_request(:get_authorizer, params)
  req.send_request(options)
end

#get_authorizers(params = {}) ⇒ Types::Authorizers

Describe an existing Authorizers resource.

[AWS CLI][1]

Examples:

Request syntax with placeholder values


resp = client.get_authorizers({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
resp.items[0].provider_arns #=> Array
resp.items[0].provider_arns[0] #=> String
resp.items[0].auth_type #=> String
resp.items[0].authorizer_uri #=> String
resp.items[0].authorizer_credentials #=> String
resp.items[0].identity_source #=> String
resp.items[0].identity_validation_expression #=> String
resp.items[0].authorizer_result_ttl_in_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page.

Returns:



1871
1872
1873
1874
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1871

def get_authorizers(params = {}, options = {})
  req = build_request(:get_authorizers, params)
  req.send_request(options)
end

#get_base_path_mapping(params = {}) ⇒ Types::BasePathMapping

Describe a BasePathMapping resource.

Examples:

Request syntax with placeholder values


resp = client.get_base_path_mapping({
  domain_name: "String", # required
  base_path: "String", # required
})

Response structure


resp.base_path #=> String
resp.rest_api_id #=> String
resp.stage #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The domain name of the BasePathMapping resource to be described.

  • :base_path (required, String)

    The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.

Returns:



1908
1909
1910
1911
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1908

def get_base_path_mapping(params = {}, options = {})
  req = build_request(:get_base_path_mapping, params)
  req.send_request(options)
end

#get_base_path_mappings(params = {}) ⇒ Types::BasePathMappings

Represents a collection of BasePathMapping resources.

Examples:

Request syntax with placeholder values


resp = client.get_base_path_mappings({
  domain_name: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].base_path #=> String
resp.items[0].rest_api_id #=> String
resp.items[0].stage #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The domain name of a BasePathMapping resource.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

Returns:



1948
1949
1950
1951
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1948

def get_base_path_mappings(params = {}, options = {})
  req = build_request(:get_base_path_mappings, params)
  req.send_request(options)
end

#get_client_certificate(params = {}) ⇒ Types::ClientCertificate

Gets information about the current ClientCertificate resource.

Examples:

Request syntax with placeholder values


resp = client.get_client_certificate({
  client_certificate_id: "String", # required
})

Response structure


resp.client_certificate_id #=> String
resp.description #=> String
resp.pem_encoded_certificate #=> String
resp.created_date #=> Time
resp.expiration_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :client_certificate_id (required, String)

    The identifier of the ClientCertificate resource to be described.

Returns:



1982
1983
1984
1985
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1982

def get_client_certificate(params = {}, options = {})
  req = build_request(:get_client_certificate, params)
  req.send_request(options)
end

#get_client_certificates(params = {}) ⇒ Types::ClientCertificates

Gets a collection of ClientCertificate resources.

Examples:

Request syntax with placeholder values


resp = client.get_client_certificates({
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].client_certificate_id #=> String
resp.items[0].description #=> String
resp.items[0].pem_encoded_certificate #=> String
resp.items[0].created_date #=> Time
resp.items[0].expiration_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

Returns:



2020
2021
2022
2023
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2020

def get_client_certificates(params = {}, options = {})
  req = build_request(:get_client_certificates, params)
  req.send_request(options)
end

#get_deployment(params = {}) ⇒ Types::Deployment

Gets information about a Deployment resource.

Examples:

Request syntax with placeholder values


resp = client.get_deployment({
  rest_api_id: "String", # required
  deployment_id: "String", # required
  embed: ["String"],
})

Response structure


resp.id #=> String
resp.description #=> String
resp.created_date #=> Time
resp.api_summary #=> Hash
resp.api_summary["String"] #=> Hash
resp.api_summary["String"]["String"].authorization_type #=> String
resp.api_summary["String"]["String"].api_key_required #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :deployment_id (required, String)

    The identifier of the Deployment resource to get information about.

  • :embed (Array<String>)

    A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=apisummary.

Returns:



2073
2074
2075
2076
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2073

def get_deployment(params = {}, options = {})
  req = build_request(:get_deployment, params)
  req.send_request(options)
end

#get_deployments(params = {}) ⇒ Types::Deployments

Gets information about a Deployments collection.

Examples:

Request syntax with placeholder values


resp = client.get_deployments({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].description #=> String
resp.items[0].created_date #=> Time
resp.items[0].api_summary #=> Hash
resp.items[0].api_summary["String"] #=> Hash
resp.items[0].api_summary["String"]["String"].authorization_type #=> String
resp.items[0].api_summary["String"]["String"].api_key_required #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

Returns:



2117
2118
2119
2120
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2117

def get_deployments(params = {}, options = {})
  req = build_request(:get_deployments, params)
  req.send_request(options)
end

#get_documentation_part(params = {}) ⇒ Types::DocumentationPart

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_documentation_part({
  rest_api_id: "String", # required
  documentation_part_id: "String", # required
})

Response structure


resp.id #=> String
resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
resp.location.path #=> String
resp.location.method #=> String
resp.location.status_code #=> String
resp.location.name #=> String
resp.properties #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :documentation_part_id (required, String)

    [Required] The string identifier of the associated RestApi.

Returns:



2153
2154
2155
2156
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2153

def get_documentation_part(params = {}, options = {})
  req = build_request(:get_documentation_part, params)
  req.send_request(options)
end

#get_documentation_parts(params = {}) ⇒ Types::DocumentationParts

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_documentation_parts({
  rest_api_id: "String", # required
  type: "API", # accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
  name_query: "String",
  path: "String",
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
resp.items[0].location.path #=> String
resp.items[0].location.method #=> String
resp.items[0].location.status_code #=> String
resp.items[0].location.name #=> String
resp.items[0].properties #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :type (String)

    The type of API entities of the to-be-retrieved documentation parts.

  • :name_query (String)

    The name of API entities of the to-be-retrieved documentation parts.

  • :path (String)

    The path of API entities of the to-be-retrieved documentation parts.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page.

Returns:



2206
2207
2208
2209
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2206

def get_documentation_parts(params = {}, options = {})
  req = build_request(:get_documentation_parts, params)
  req.send_request(options)
end

#get_documentation_version(params = {}) ⇒ Types::DocumentationVersion

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_documentation_version({
  rest_api_id: "String", # required
  documentation_version: "String", # required
})

Response structure


resp.version #=> String
resp.created_date #=> Time
resp.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :documentation_version (required, String)

    [Required] The version identifier of the to-be-retrieved documentation snapshot.

Returns:



2239
2240
2241
2242
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2239

def get_documentation_version(params = {}, options = {})
  req = build_request(:get_documentation_version, params)
  req.send_request(options)
end

#get_documentation_versions(params = {}) ⇒ Types::DocumentationVersions

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_documentation_versions({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].version #=> String
resp.items[0].created_date #=> Time
resp.items[0].description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page.

Returns:



2276
2277
2278
2279
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2276

def get_documentation_versions(params = {}, options = {})
  req = build_request(:get_documentation_versions, params)
  req.send_request(options)
end

#get_domain_name(params = {}) ⇒ Types::DomainName

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

Examples:

Request syntax with placeholder values


resp = client.get_domain_name({
  domain_name: "String", # required
})

Response structure


resp.domain_name #=> String
resp.certificate_name #=> String
resp.certificate_arn #=> String
resp.certificate_upload_date #=> Time
resp.distribution_domain_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the DomainName resource.

Returns:



2311
2312
2313
2314
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2311

def get_domain_name(params = {}, options = {})
  req = build_request(:get_domain_name, params)
  req.send_request(options)
end

#get_domain_names(params = {}) ⇒ Types::DomainNames

Represents a collection of DomainName resources.

Examples:

Request syntax with placeholder values


resp = client.get_domain_names({
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].domain_name #=> String
resp.items[0].certificate_name #=> String
resp.items[0].certificate_arn #=> String
resp.items[0].certificate_upload_date #=> Time
resp.items[0].distribution_domain_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

Returns:



2349
2350
2351
2352
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2349

def get_domain_names(params = {}, options = {})
  req = build_request(:get_domain_names, params)
  req.send_request(options)
end

#get_export(params = {}) ⇒ Types::ExportResponse

Exports a deployed version of a RestApi in a specified format.

Examples:

Request syntax with placeholder values


resp = client.get_export({
  rest_api_id: "String", # required
  stage_name: "String", # required
  export_type: "String", # required
  parameters: {
    "String" => "String",
  },
  accepts: "String",
})

Response structure


resp.content_type #=> String
resp.content_disposition #=> String
resp.body #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :stage_name (required, String)

    The name of the Stage that will be exported.

  • :export_type (required, String)

    The type of export. Currently only 'swagger' is supported.

  • :parameters (Hash<String,String>)

    A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType swagger, any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration extensions. authorizers will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

  • :accepts (String)

    The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType of swagger. This should be specified in the Accept header for direct API requests.

Returns:



2407
2408
2409
2410
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2407

def get_export(params = {}, options = {})
  req = build_request(:get_export, params)
  req.send_request(options)
end

#get_gateway_response(params = {}) ⇒ Types::GatewayResponse

Gets a GatewayResponse of a specified response type on the given RestApi.

Examples:

Request syntax with placeholder values


resp = client.get_gateway_response({
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
})

Response structure


resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.default_response #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :response_type (required, String)

    The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPES

Returns:



2468
2469
2470
2471
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2468

def get_gateway_response(params = {}, options = {})
  req = build_request(:get_gateway_response, params)
  req.send_request(options)
end

#get_gateway_responses(params = {}) ⇒ Types::GatewayResponses

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.

Examples:

Request syntax with placeholder values


resp = client.get_gateway_responses({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
resp.items[0].status_code #=> String
resp.items[0].response_parameters #=> Hash
resp.items[0].response_parameters["String"] #=> String
resp.items[0].response_templates #=> Hash
resp.items[0].response_templates["String"] #=> String
resp.items[0].default_response #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :position (String)

    The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

  • :limit (Integer)

    The maximum number of returned results per page. The GatewayResponses collection does not support pagination and the limit does not apply here.

Returns:



2518
2519
2520
2521
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2518

def get_gateway_responses(params = {}, options = {})
  req = build_request(:get_gateway_responses, params)
  req.send_request(options)
end

#get_integration(params = {}) ⇒ Types::Integration

Represents a get integration.

Examples:

Request syntax with placeholder values


resp = client.get_integration({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
})

Response structure


resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.http_method #=> String
resp.uri #=> String
resp.credentials #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> String
resp.request_templates #=> Hash
resp.request_templates["String"] #=> String
resp.passthrough_behavior #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.cache_namespace #=> String
resp.cache_key_parameters #=> Array
resp.cache_key_parameters[0] #=> String
resp.integration_responses #=> Hash
resp.integration_responses["String"].status_code #=> String
resp.integration_responses["String"].selection_pattern #=> String
resp.integration_responses["String"].response_parameters #=> Hash
resp.integration_responses["String"].response_parameters["String"] #=> String
resp.integration_responses["String"].response_templates #=> Hash
resp.integration_responses["String"].response_templates["String"] #=> String
resp.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    Specifies a get integration request's resource identifier

  • :http_method (required, String)

    Specifies a get integration request's HTTP method.

Returns:



2582
2583
2584
2585
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2582

def get_integration(params = {}, options = {})
  req = build_request(:get_integration, params)
  req.send_request(options)
end

#get_integration_response(params = {}) ⇒ Types::IntegrationResponse

Represents a get integration response.

Examples:

Request syntax with placeholder values


resp = client.get_integration_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
})

Response structure


resp.status_code #=> String
resp.selection_pattern #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    Specifies a get integration response request's resource identifier.

  • :http_method (required, String)

    Specifies a get integration response request's HTTP method.

  • :status_code (required, String)

    Specifies a get integration response request's status code.

Returns:



2630
2631
2632
2633
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2630

def get_integration_response(params = {}, options = {})
  req = build_request(:get_integration_response, params)
  req.send_request(options)
end

#get_method(params = {}) ⇒ Types::Method

Describe an existing Method resource.

Examples:

Request syntax with placeholder values


resp = client.get_method({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
})

Response structure


resp.http_method #=> String
resp.authorization_type #=> String
resp.authorizer_id #=> String
resp.api_key_required #=> Boolean
resp.request_validator_id #=> String
resp.operation_name #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> Boolean
resp.request_models #=> Hash
resp.request_models["String"] #=> String
resp.method_responses #=> Hash
resp.method_responses["String"].status_code #=> String
resp.method_responses["String"].response_parameters #=> Hash
resp.method_responses["String"].response_parameters["String"] #=> Boolean
resp.method_responses["String"].response_models #=> Hash
resp.method_responses["String"].response_models["String"] #=> String
resp.method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.method_integration.http_method #=> String
resp.method_integration.uri #=> String
resp.method_integration.credentials #=> String
resp.method_integration.request_parameters #=> Hash
resp.method_integration.request_parameters["String"] #=> String
resp.method_integration.request_templates #=> Hash
resp.method_integration.request_templates["String"] #=> String
resp.method_integration.passthrough_behavior #=> String
resp.method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.method_integration.cache_namespace #=> String
resp.method_integration.cache_key_parameters #=> Array
resp.method_integration.cache_key_parameters[0] #=> String
resp.method_integration.integration_responses #=> Hash
resp.method_integration.integration_responses["String"].status_code #=> String
resp.method_integration.integration_responses["String"].selection_pattern #=> String
resp.method_integration.integration_responses["String"].response_parameters #=> Hash
resp.method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.method_integration.integration_responses["String"].response_templates #=> Hash
resp.method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    The Resource identifier for the Method resource.

  • :http_method (required, String)

    Specifies the method request's HTTP method type.

Returns:



2709
2710
2711
2712
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2709

def get_method(params = {}, options = {})
  req = build_request(:get_method, params)
  req.send_request(options)
end

#get_method_response(params = {}) ⇒ Types::MethodResponse

Describes a MethodResponse resource.

Examples:

Request syntax with placeholder values


resp = client.get_method_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
})

Response structure


resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> Boolean
resp.response_models #=> Hash
resp.response_models["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    The Resource identifier for the MethodResponse resource.

  • :http_method (required, String)

    The HTTP verb of the Method resource.

  • :status_code (required, String)

    The status code for the MethodResponse resource.

Returns:



2753
2754
2755
2756
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2753

def get_method_response(params = {}, options = {})
  req = build_request(:get_method_response, params)
  req.send_request(options)
end

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

Describes an existing model defined for a RestApi resource.

Examples:

Request syntax with placeholder values


resp = client.get_model({
  rest_api_id: "String", # required
  model_name: "String", # required
  flatten: false,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.schema #=> String
resp.content_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The RestApi identifier under which the Model exists.

  • :model_name (required, String)

    The name of the model as an identifier.

  • :flatten (Boolean)

    A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

Returns:



2797
2798
2799
2800
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2797

def get_model(params = {}, options = {})
  req = build_request(:get_model, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.get_model_template({
  rest_api_id: "String", # required
  model_name: "String", # required
})

Response structure


resp.value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :model_name (required, String)

    The name of the model for which to generate a template.

Returns:



2828
2829
2830
2831
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2828

def get_model_template(params = {}, options = {})
  req = build_request(:get_model_template, params)
  req.send_request(options)
end

#get_models(params = {}) ⇒ Types::Models

Describes existing Models defined for a RestApi resource.

Examples:

Request syntax with placeholder values


resp = client.get_models({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].schema #=> String
resp.items[0].content_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

Returns:



2870
2871
2872
2873
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2870

def get_models(params = {}, options = {})
  req = build_request(:get_models, params)
  req.send_request(options)
end

#get_request_validator(params = {}) ⇒ Types::RequestValidator

Gets a RequestValidator of a given RestApi.

Examples:

Request syntax with placeholder values


resp = client.get_request_validator({
  rest_api_id: "String", # required
  request_validator_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.validate_request_body #=> Boolean
resp.validate_request_parameters #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :request_validator_id (required, String)

    [Required] The identifier of the RequestValidator to be retrieved.

Returns:



2906
2907
2908
2909
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2906

def get_request_validator(params = {}, options = {})
  req = build_request(:get_request_validator, params)
  req.send_request(options)
end

#get_request_validators(params = {}) ⇒ Types::RequestValidators

Gets the RequestValidators collection of a given RestApi.

Examples:

Request syntax with placeholder values


resp = client.get_request_validators({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].validate_request_body #=> Boolean
resp.items[0].validate_request_parameters #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page.

Returns:



2946
2947
2948
2949
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2946

def get_request_validators(params = {}, options = {})
  req = build_request(:get_request_validators, params)
  req.send_request(options)
end

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

Lists information about a resource.

Examples:

Request syntax with placeholder values


resp = client.get_resource({
  rest_api_id: "String", # required
  resource_id: "String", # required
  embed: ["String"],
})

Response structure


resp.id #=> String
resp.parent_id #=> String
resp.path_part #=> String
resp.path #=> String
resp.resource_methods #=> Hash
resp.resource_methods["String"].http_method #=> String
resp.resource_methods["String"].authorization_type #=> String
resp.resource_methods["String"].authorizer_id #=> String
resp.resource_methods["String"].api_key_required #=> Boolean
resp.resource_methods["String"].request_validator_id #=> String
resp.resource_methods["String"].operation_name #=> String
resp.resource_methods["String"].request_parameters #=> Hash
resp.resource_methods["String"].request_parameters["String"] #=> Boolean
resp.resource_methods["String"].request_models #=> Hash
resp.resource_methods["String"].request_models["String"] #=> String
resp.resource_methods["String"].method_responses #=> Hash
resp.resource_methods["String"].method_responses["String"].status_code #=> String
resp.resource_methods["String"].method_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_responses["String"].response_parameters["String"] #=> Boolean
resp.resource_methods["String"].method_responses["String"].response_models #=> Hash
resp.resource_methods["String"].method_responses["String"].response_models["String"] #=> String
resp.resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.resource_methods["String"].method_integration.http_method #=> String
resp.resource_methods["String"].method_integration.uri #=> String
resp.resource_methods["String"].method_integration.credentials #=> String
resp.resource_methods["String"].method_integration.request_parameters #=> Hash
resp.resource_methods["String"].method_integration.request_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.request_templates #=> Hash
resp.resource_methods["String"].method_integration.request_templates["String"] #=> String
resp.resource_methods["String"].method_integration.passthrough_behavior #=> String
resp.resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.resource_methods["String"].method_integration.cache_namespace #=> String
resp.resource_methods["String"].method_integration.cache_key_parameters #=> Array
resp.resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
resp.resource_methods["String"].method_integration.integration_responses #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    The identifier for the Resource resource.

  • :embed (Array<String>)

    A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/\{restapi_id\}/resources/\{resource_id\}?embed=methods.

Returns:



3031
3032
3033
3034
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3031

def get_resource(params = {}, options = {})
  req = build_request(:get_resource, params)
  req.send_request(options)
end

#get_resources(params = {}) ⇒ Types::Resources

Lists information about a collection of Resource resources.

Examples:

Request syntax with placeholder values


resp = client.get_resources({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
  embed: ["String"],
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].parent_id #=> String
resp.items[0].path_part #=> String
resp.items[0].path #=> String
resp.items[0].resource_methods #=> Hash
resp.items[0].resource_methods["String"].http_method #=> String
resp.items[0].resource_methods["String"].authorization_type #=> String
resp.items[0].resource_methods["String"].authorizer_id #=> String
resp.items[0].resource_methods["String"].api_key_required #=> Boolean
resp.items[0].resource_methods["String"].request_validator_id #=> String
resp.items[0].resource_methods["String"].operation_name #=> String
resp.items[0].resource_methods["String"].request_parameters #=> Hash
resp.items[0].resource_methods["String"].request_parameters["String"] #=> Boolean
resp.items[0].resource_methods["String"].request_models #=> Hash
resp.items[0].resource_methods["String"].request_models["String"] #=> String
resp.items[0].resource_methods["String"].method_responses #=> Hash
resp.items[0].resource_methods["String"].method_responses["String"].status_code #=> String
resp.items[0].resource_methods["String"].method_responses["String"].response_parameters #=> Hash
resp.items[0].resource_methods["String"].method_responses["String"].response_parameters["String"] #=> Boolean
resp.items[0].resource_methods["String"].method_responses["String"].response_models #=> Hash
resp.items[0].resource_methods["String"].method_responses["String"].response_models["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.items[0].resource_methods["String"].method_integration.http_method #=> String
resp.items[0].resource_methods["String"].method_integration.uri #=> String
resp.items[0].resource_methods["String"].method_integration.credentials #=> String
resp.items[0].resource_methods["String"].method_integration.request_parameters #=> Hash
resp.items[0].resource_methods["String"].method_integration.request_parameters["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.request_templates #=> Hash
resp.items[0].resource_methods["String"].method_integration.request_templates["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.passthrough_behavior #=> String
resp.items[0].resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.items[0].resource_methods["String"].method_integration.cache_namespace #=> String
resp.items[0].resource_methods["String"].method_integration.cache_key_parameters #=> Array
resp.items[0].resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses #=> Hash
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

  • :embed (Array<String>)

    A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/\{restapi_id\}/resources?embed=methods.

Returns:



3120
3121
3122
3123
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3120

def get_resources(params = {}, options = {})
  req = build_request(:get_resources, params)
  req.send_request(options)
end

#get_rest_api(params = {}) ⇒ Types::RestApi

Lists the RestApi resource in the collection.

Examples:

Request syntax with placeholder values


resp = client.get_rest_api({
  rest_api_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String
resp.binary_media_types #=> Array
resp.binary_media_types[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The identifier of the RestApi resource.

Returns:



3160
3161
3162
3163
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3160

def get_rest_api(params = {}, options = {})
  req = build_request(:get_rest_api, params)
  req.send_request(options)
end

#get_rest_apis(params = {}) ⇒ Types::RestApis

Lists the RestApis resources for your collection.

Examples:

Request syntax with placeholder values


resp = client.get_rest_apis({
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].created_date #=> Time
resp.items[0].version #=> String
resp.items[0].warnings #=> Array
resp.items[0].warnings[0] #=> String
resp.items[0].binary_media_types #=> Array
resp.items[0].binary_media_types[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

Returns:



3202
3203
3204
3205
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3202

def get_rest_apis(params = {}, options = {})
  req = build_request(:get_rest_apis, params)
  req.send_request(options)
end

#get_sdk(params = {}) ⇒ Types::SdkResponse

Generates a client SDK for a RestApi and Stage.

Examples:

Request syntax with placeholder values


resp = client.get_sdk({
  rest_api_id: "String", # required
  stage_name: "String", # required
  sdk_type: "String", # required
  parameters: {
    "String" => "String",
  },
})

Response structure


resp.content_type #=> String
resp.content_disposition #=> String
resp.body #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :stage_name (required, String)

    The name of the Stage that the SDK will use.

  • :sdk_type (required, String)

    The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.

  • :parameters (Hash<String,String>)

    A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType of objectivec, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required.

Returns:



3251
3252
3253
3254
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3251

def get_sdk(params = {}, options = {})
  req = build_request(:get_sdk, params)
  req.send_request(options)
end

#get_sdk_type(params = {}) ⇒ Types::SdkType

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_sdk_type({
  id: "String", # required
})

Response structure


resp.id #=> String
resp.friendly_name #=> String
resp.description #=> String
resp.configuration_properties #=> Array
resp.configuration_properties[0].name #=> String
resp.configuration_properties[0].friendly_name #=> String
resp.configuration_properties[0].description #=> String
resp.configuration_properties[0].required #=> Boolean
resp.configuration_properties[0].default_value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The identifier of the queried SdkType instance.

Returns:



3286
3287
3288
3289
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3286

def get_sdk_type(params = {}, options = {})
  req = build_request(:get_sdk_type, params)
  req.send_request(options)
end

#get_sdk_types(params = {}) ⇒ Types::SdkTypes

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_sdk_types({
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].friendly_name #=> String
resp.items[0].description #=> String
resp.items[0].configuration_properties #=> Array
resp.items[0].configuration_properties[0].name #=> String
resp.items[0].configuration_properties[0].friendly_name #=> String
resp.items[0].configuration_properties[0].description #=> String
resp.items[0].configuration_properties[0].required #=> Boolean
resp.items[0].configuration_properties[0].default_value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page.

Returns:



3325
3326
3327
3328
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3325

def get_sdk_types(params = {}, options = {})
  req = build_request(:get_sdk_types, params)
  req.send_request(options)
end

#get_stage(params = {}) ⇒ Types::Stage

Gets information about a Stage resource.

Examples:

Request syntax with placeholder values


resp = client.get_stage({
  rest_api_id: "String", # required
  stage_name: "String", # required
})

Response structure


resp.deployment_id #=> String
resp.client_certificate_id #=> String
resp.stage_name #=> String
resp.description #=> String
resp.cache_cluster_enabled #=> Boolean
resp.cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
resp.cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
resp.method_settings #=> Hash
resp.method_settings["String"].metrics_enabled #=> Boolean
resp.method_settings["String"].logging_level #=> String
resp.method_settings["String"].data_trace_enabled #=> Boolean
resp.method_settings["String"].throttling_burst_limit #=> Integer
resp.method_settings["String"].throttling_rate_limit #=> Float
resp.method_settings["String"].caching_enabled #=> Boolean
resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.method_settings["String"].cache_data_encrypted #=> Boolean
resp.method_settings["String"].require_authorization_for_cache_control #=> Boolean
resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
resp.variables #=> Hash
resp.variables["String"] #=> String
resp.documentation_version #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :stage_name (required, String)

    The name of the Stage resource to get information about.

Returns:



3388
3389
3390
3391
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3388

def get_stage(params = {}, options = {})
  req = build_request(:get_stage, params)
  req.send_request(options)
end

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

Gets information about one or more Stage resources.

Examples:

Request syntax with placeholder values


resp = client.get_stages({
  rest_api_id: "String", # required
  deployment_id: "String",
})

Response structure


resp.item #=> Array
resp.item[0].deployment_id #=> String
resp.item[0].client_certificate_id #=> String
resp.item[0].stage_name #=> String
resp.item[0].description #=> String
resp.item[0].cache_cluster_enabled #=> Boolean
resp.item[0].cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
resp.item[0].cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
resp.item[0].method_settings #=> Hash
resp.item[0].method_settings["String"].metrics_enabled #=> Boolean
resp.item[0].method_settings["String"].logging_level #=> String
resp.item[0].method_settings["String"].data_trace_enabled #=> Boolean
resp.item[0].method_settings["String"].throttling_burst_limit #=> Integer
resp.item[0].method_settings["String"].throttling_rate_limit #=> Float
resp.item[0].method_settings["String"].caching_enabled #=> Boolean
resp.item[0].method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.item[0].method_settings["String"].cache_data_encrypted #=> Boolean
resp.item[0].method_settings["String"].require_authorization_for_cache_control #=> Boolean
resp.item[0].method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
resp.item[0].variables #=> Hash
resp.item[0].variables["String"] #=> String
resp.item[0].documentation_version #=> String
resp.item[0].created_date #=> Time
resp.item[0].last_updated_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :deployment_id (String)

    The stages' deployment identifiers.

Returns:



3441
3442
3443
3444
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3441

def get_stages(params = {}, options = {})
  req = build_request(:get_stages, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.get_usage({
  usage_plan_id: "String", # required
  key_id: "String",
  start_date: "String", # required
  end_date: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.usage_plan_id #=> String
resp.start_date #=> String
resp.end_date #=> String
resp.position #=> String
resp.items #=> Hash
resp.items["String"] #=> Array
resp.items["String"][0] #=> Array
resp.items["String"][0][0] #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String)

    The Id of the usage plan associated with the usage data.

  • :key_id (String)

    The Id of the API key associated with the resultant usage data.

  • :start_date (required, String)

    The starting date (e.g., 2016-01-01) of the usage data.

  • :end_date (required, String)

    The ending date (e.g., 2016-12-31) of the usage data.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page.

Returns:



3498
3499
3500
3501
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3498

def get_usage(params = {}, options = {})
  req = build_request(:get_usage, params)
  req.send_request(options)
end

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

Gets a usage plan of a given plan identifier.

Examples:

Request syntax with placeholder values


resp = client.get_usage_plan({
  usage_plan_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.api_stages #=> Array
resp.api_stages[0].api_id #=> String
resp.api_stages[0].stage #=> String
resp.throttle.burst_limit #=> Integer
resp.throttle.rate_limit #=> Float
resp.quota.limit #=> Integer
resp.quota.offset #=> Integer
resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
resp.product_code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String)

    The identifier of the UsagePlan resource to be retrieved.

Returns:



3541
3542
3543
3544
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3541

def get_usage_plan(params = {}, options = {})
  req = build_request(:get_usage_plan, params)
  req.send_request(options)
end

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

Gets a usage plan key of a given key identifier.

Examples:

Request syntax with placeholder values


resp = client.get_usage_plan_key({
  usage_plan_id: "String", # required
  key_id: "String", # required
})

Response structure


resp.id #=> String
resp.type #=> String
resp.value #=> String
resp.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String)

    The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

  • :key_id (required, String)

    The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

Returns:



3580
3581
3582
3583
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3580

def get_usage_plan_key(params = {}, options = {})
  req = build_request(:get_usage_plan_key, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.get_usage_plan_keys({
  usage_plan_id: "String", # required
  position: "String",
  limit: 1,
  name_query: "String",
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].type #=> String
resp.items[0].value #=> String
resp.items[0].name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String)

    The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

  • :position (String)

    The current pagination position in the paged result set.

  • :limit (Integer)

    The maximum number of returned results per page.

  • :name_query (String)

    A query parameter specifying the name of the to-be-returned usage plan keys.

Returns:



3628
3629
3630
3631
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3628

def get_usage_plan_keys(params = {}, options = {})
  req = build_request(:get_usage_plan_keys, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.get_usage_plans({
  position: "String",
  key_id: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].api_stages #=> Array
resp.items[0].api_stages[0].api_id #=> String
resp.items[0].api_stages[0].stage #=> String
resp.items[0].throttle.burst_limit #=> Integer
resp.items[0].throttle.rate_limit #=> Float
resp.items[0].quota.limit #=> Integer
resp.items[0].quota.offset #=> Integer
resp.items[0].quota.period #=> String, one of "DAY", "WEEK", "MONTH"
resp.items[0].product_code #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :position (String)

    The current pagination position in the paged result set.

  • :key_id (String)

    The identifier of the API key associated with the usage plans.

  • :limit (Integer)

    The maximum number of returned results per page.

Returns:



3676
3677
3678
3679
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3676

def get_usage_plans(params = {}, options = {})
  req = build_request(:get_usage_plans, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.import_api_keys({
  body: "data", # required
  format: "csv", # required, accepts csv
  fail_on_warnings: false,
})

Response structure


resp.ids #=> Array
resp.ids[0] #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :body (required, String, IO)

    The payload of the POST request to import API keys. For the payload format, see API Key File Format.

  • :format (required, String)

    A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

  • :fail_on_warnings (Boolean)

    A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

Returns:



3721
3722
3723
3724
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3721

def import_api_keys(params = {}, options = {})
  req = build_request(:import_api_keys, params)
  req.send_request(options)
end

#import_documentation_parts(params = {}) ⇒ Types::DocumentationPartIds

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.import_documentation_parts({
  rest_api_id: "String", # required
  mode: "merge", # accepts merge, overwrite
  fail_on_warnings: false,
  body: "data", # required
})

Response structure


resp.ids #=> Array
resp.ids[0] #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :mode (String)

    A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

  • :fail_on_warnings (Boolean)

    A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

  • :body (required, String, IO)

    [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.

Returns:



3767
3768
3769
3770
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3767

def import_documentation_parts(params = {}, options = {})
  req = build_request(:import_documentation_parts, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.import_rest_api({
  fail_on_warnings: false,
  parameters: {
    "String" => "String",
  },
  body: "data", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String
resp.binary_media_types #=> Array
resp.binary_media_types[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :fail_on_warnings (Boolean)

    A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

  • :parameters (Hash<String,String>)

    Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json.

  • :body (required, String, IO)

    The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.

Returns:



3826
3827
3828
3829
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3826

def import_rest_api(params = {}, options = {})
  req = build_request(:import_rest_api, params)
  req.send_request(options)
end

#put_gateway_response(params = {}) ⇒ Types::GatewayResponse

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Examples:

Request syntax with placeholder values


resp = client.put_gateway_response({
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
  status_code: "StatusCode",
  response_parameters: {
    "String" => "String",
  },
  response_templates: {
    "String" => "String",
  },
})

Response structure


resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.default_response #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :response_type (required, String)

    The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPES

  • :status_code (String)

    The HTTP status code of the GatewayResponse.

  • :response_parameters (Hash<String,String>)

    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

  • :response_templates (Hash<String,String>)

    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

Returns:



3905
3906
3907
3908
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3905

def put_gateway_response(params = {}, options = {})
  req = build_request(:put_gateway_response, params)
  req.send_request(options)
end

#put_integration(params = {}) ⇒ Types::Integration

Sets up a method's integration.

Examples:

Request syntax with placeholder values


resp = client.put_integration({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  type: "HTTP", # required, accepts HTTP, AWS, MOCK, HTTP_PROXY, AWS_PROXY
  integration_http_method: "String",
  uri: "String",
  credentials: "String",
  request_parameters: {
    "String" => "String",
  },
  request_templates: {
    "String" => "String",
  },
  passthrough_behavior: "String",
  cache_namespace: "String",
  cache_key_parameters: ["String"],
  content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
})

Response structure


resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.http_method #=> String
resp.uri #=> String
resp.credentials #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> String
resp.request_templates #=> Hash
resp.request_templates["String"] #=> String
resp.passthrough_behavior #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.cache_namespace #=> String
resp.cache_key_parameters #=> Array
resp.cache_key_parameters[0] #=> String
resp.integration_responses #=> Hash
resp.integration_responses["String"].status_code #=> String
resp.integration_responses["String"].selection_pattern #=> String
resp.integration_responses["String"].response_parameters #=> Hash
resp.integration_responses["String"].response_parameters["String"] #=> String
resp.integration_responses["String"].response_templates #=> Hash
resp.integration_responses["String"].response_templates["String"] #=> String
resp.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    Specifies a put integration request's resource ID.

  • :http_method (required, String)

    Specifies a put integration request's HTTP method.

  • :type (required, String)

    Specifies a put integration input's type.

  • :integration_http_method (String)

    Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

  • :uri (String)

    Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:\{path|action\}/\{service_api\}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.

  • :credentials (String)

    Specifies whether credentials are required for a put integration.

  • :request_parameters (Hash<String,String>)

    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.\{location\}.\{name\}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

  • :request_templates (Hash<String,String>)

    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

  • :passthrough_behavior (String)

    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

    • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

    • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

    • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

  • :cache_namespace (String)

    Specifies a put integration input's cache namespace.

  • :cache_key_parameters (Array<String>)

    Specifies a put integration input's cache key parameters.

  • :content_handling (String)

    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

    • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

    • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

Returns:



4067
4068
4069
4070
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4067

def put_integration(params = {}, options = {})
  req = build_request(:put_integration, params)
  req.send_request(options)
end

#put_integration_response(params = {}) ⇒ Types::IntegrationResponse

Represents a put integration.

Examples:

Request syntax with placeholder values


resp = client.put_integration_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
  selection_pattern: "String",
  response_parameters: {
    "String" => "String",
  },
  response_templates: {
    "String" => "String",
  },
  content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
})

Response structure


resp.status_code #=> String
resp.selection_pattern #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    Specifies a put integration response request's resource identifier.

  • :http_method (required, String)

    Specifies a put integration response request's HTTP method.

  • :status_code (required, String)

    Specifies the status code that is used to map the integration response to an existing MethodResponse.

  • :selection_pattern (String)

    Specifies the selection pattern of a put integration response.

  • :response_parameters (Hash<String,String>)

    A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.\{name\}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.\{name\} or integration.response.body.\{JSON-expression\}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

  • :response_templates (Hash<String,String>)

    Specifies a put integration response's templates.

  • :content_handling (String)

    Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

    • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

    • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

    If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Returns:



4158
4159
4160
4161
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4158

def put_integration_response(params = {}, options = {})
  req = build_request(:put_integration_response, params)
  req.send_request(options)
end

#put_method(params = {}) ⇒ Types::Method

Add a method to an existing Resource resource.

Examples:

Request syntax with placeholder values


resp = client.put_method({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  authorization_type: "String", # required
  authorizer_id: "String",
  api_key_required: false,
  operation_name: "String",
  request_parameters: {
    "String" => false,
  },
  request_models: {
    "String" => "String",
  },
  request_validator_id: "String",
})

Response structure


resp.http_method #=> String
resp.authorization_type #=> String
resp.authorizer_id #=> String
resp.api_key_required #=> Boolean
resp.request_validator_id #=> String
resp.operation_name #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> Boolean
resp.request_models #=> Hash
resp.request_models["String"] #=> String
resp.method_responses #=> Hash
resp.method_responses["String"].status_code #=> String
resp.method_responses["String"].response_parameters #=> Hash
resp.method_responses["String"].response_parameters["String"] #=> Boolean
resp.method_responses["String"].response_models #=> Hash
resp.method_responses["String"].response_models["String"] #=> String
resp.method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.method_integration.http_method #=> String
resp.method_integration.uri #=> String
resp.method_integration.credentials #=> String
resp.method_integration.request_parameters #=> Hash
resp.method_integration.request_parameters["String"] #=> String
resp.method_integration.request_templates #=> Hash
resp.method_integration.request_templates["String"] #=> String
resp.method_integration.passthrough_behavior #=> String
resp.method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.method_integration.cache_namespace #=> String
resp.method_integration.cache_key_parameters #=> Array
resp.method_integration.cache_key_parameters[0] #=> String
resp.method_integration.integration_responses #=> Hash
resp.method_integration.integration_responses["String"].status_code #=> String
resp.method_integration.integration_responses["String"].selection_pattern #=> String
resp.method_integration.integration_responses["String"].response_parameters #=> Hash
resp.method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.method_integration.integration_responses["String"].response_templates #=> Hash
resp.method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    The Resource identifier for the new Method resource.

  • :http_method (required, String)

    Specifies the method request's HTTP method type.

  • :authorization_type (required, String)

    The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

  • :authorizer_id (String)

    Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.

  • :api_key_required (Boolean)

    Specifies whether the method required a valid ApiKey.

  • :operation_name (String)

    A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

  • :request_parameters (Hash<String,Boolean>)

    A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key defines a method request parameter name matching the pattern of method.request.\{location\}.\{name\}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

  • :request_models (Hash<String,String>)

    Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

  • :request_validator_id (String)

    The identifier of a RequestValidator for validating the method request.

Returns:



4291
4292
4293
4294
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4291

def put_method(params = {}, options = {})
  req = build_request(:put_method, params)
  req.send_request(options)
end

#put_method_response(params = {}) ⇒ Types::MethodResponse

Adds a MethodResponse to an existing Method resource.

Examples:

Request syntax with placeholder values


resp = client.put_method_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
  response_parameters: {
    "String" => false,
  },
  response_models: {
    "String" => "String",
  },
})

Response structure


resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> Boolean
resp.response_models #=> Hash
resp.response_models["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    The Resource identifier for the Method resource.

  • :http_method (required, String)

    The HTTP verb of the Method resource.

  • :status_code (required, String)

    The method response's status code.

  • :response_parameters (Hash<String,Boolean>)

    A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.\{name\}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.\{name\}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.\{JSON-expression\}, where JSON-expression is a valid JSON expression without the $ prefix.)

  • :response_models (Hash<String,String>)

    Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

Returns:



4362
4363
4364
4365
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4362

def put_method_response(params = {}, options = {})
  req = build_request(:put_method_response, params)
  req.send_request(options)
end

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

A feature of the Amazon 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.

Examples:

Request syntax with placeholder values


resp = client.put_rest_api({
  rest_api_id: "String", # required
  mode: "merge", # accepts merge, overwrite
  fail_on_warnings: false,
  parameters: {
    "String" => "String",
  },
  body: "data", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String
resp.binary_media_types #=> Array
resp.binary_media_types[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :mode (String)

    The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

  • :fail_on_warnings (Boolean)

    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

  • :parameters (Hash<String,String>)

    Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json.

  • :body (required, String, IO)

    The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.

Returns:



4433
4434
4435
4436
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4433

def put_rest_api(params = {}, options = {})
  req = build_request(:put_rest_api, params)
  req.send_request(options)
end

#test_invoke_authorizer(params = {}) ⇒ Types::TestInvokeAuthorizerResponse

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

[Enable custom authorizers][1]

Examples:

Request syntax with placeholder values


resp = client.test_invoke_authorizer({
  rest_api_id: "String", # required
  authorizer_id: "String", # required
  headers: {
    "String" => "String",
  },
  path_with_query_string: "String",
  body: "String",
  stage_variables: {
    "String" => "String",
  },
  additional_context: {
    "String" => "String",
  },
})

Response structure


resp.client_status #=> Integer
resp.log #=> String
resp.latency #=> Integer
resp.principal_id #=> String
resp.policy #=> String
resp.authorization #=> Hash
resp.authorization["String"] #=> Array
resp.authorization["String"][0] #=> String
resp.claims #=> Hash
resp.claims["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :authorizer_id (required, String)

    Specifies a test invoke authorizer request's Authorizer ID.

  • :headers (Hash<String,String>)

    [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

  • :path_with_query_string (String)

    [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

  • :body (String)

    [Optional] The simulated request body of an incoming invocation request.

  • :stage_variables (Hash<String,String>)

    A key-value map of stage variables to simulate an invocation on a deployed Stage.

  • :additional_context (Hash<String,String>)

    [Optional] A key-value map of additional context variables.

Returns:



4519
4520
4521
4522
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4519

def test_invoke_authorizer(params = {}, options = {})
  req = build_request(:test_invoke_authorizer, params)
  req.send_request(options)
end

#test_invoke_method(params = {}) ⇒ Types::TestInvokeMethodResponse

Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.

Examples:

Request syntax with placeholder values


resp = client.test_invoke_method({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  path_with_query_string: "String",
  body: "String",
  headers: {
    "String" => "String",
  },
  client_certificate_id: "String",
  stage_variables: {
    "String" => "String",
  },
})

Response structure


resp.status #=> Integer
resp.body #=> String
resp.headers #=> Hash
resp.headers["String"] #=> String
resp.log #=> String
resp.latency #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :resource_id (required, String)

    Specifies a test invoke method request's resource ID.

  • :http_method (required, String)

    Specifies a test invoke method request's HTTP method.

  • :path_with_query_string (String)

    The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

  • :body (String)

    The simulated request body of an incoming invocation request.

  • :headers (Hash<String,String>)

    A key-value map of headers to simulate an incoming invocation request.

  • :client_certificate_id (String)

    A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

  • :stage_variables (Hash<String,String>)

    A key-value map of stage variables to simulate an invocation on a deployed Stage.

Returns:



4592
4593
4594
4595
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4592

def test_invoke_method(params = {}, options = {})
  req = build_request(:test_invoke_method, params)
  req.send_request(options)
end

#update_account(params = {}) ⇒ Types::Account

Changes information about the current Account resource.

Examples:

Request syntax with placeholder values


resp = client.({
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.cloudwatch_role_arn #=> String
resp.throttle_settings.burst_limit #=> Integer
resp.throttle_settings.rate_limit #=> Float
resp.features #=> Array
resp.features[0] #=> String
resp.api_key_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



4634
4635
4636
4637
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4634

def (params = {}, options = {})
  req = build_request(:update_account, params)
  req.send_request(options)
end

#update_api_key(params = {}) ⇒ Types::ApiKey

Changes information about an ApiKey resource.

Examples:

Request syntax with placeholder values


resp = client.update_api_key({
  api_key: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.value #=> String
resp.name #=> String
resp.customer_id #=> String
resp.description #=> String
resp.enabled #=> Boolean
resp.created_date #=> Time
resp.last_updated_date #=> Time
resp.stage_keys #=> Array
resp.stage_keys[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :api_key (required, String)

    The identifier of the ApiKey resource to be updated.

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



4689
4690
4691
4692
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4689

def update_api_key(params = {}, options = {})
  req = build_request(:update_api_key, params)
  req.send_request(options)
end

#update_authorizer(params = {}) ⇒ Types::Authorizer

Updates an existing Authorizer resource.

[AWS CLI][1]

Examples:

Request syntax with placeholder values


resp = client.update_authorizer({
  rest_api_id: "String", # required
  authorizer_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
resp.provider_arns #=> Array
resp.provider_arns[0] #=> String
resp.auth_type #=> String
resp.authorizer_uri #=> String
resp.authorizer_credentials #=> String
resp.identity_source #=> String
resp.identity_validation_expression #=> String
resp.authorizer_result_ttl_in_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :authorizer_id (required, String)

    The identifier of the Authorizer resource.

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



4758
4759
4760
4761
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4758

def update_authorizer(params = {}, options = {})
  req = build_request(:update_authorizer, params)
  req.send_request(options)
end

#update_base_path_mapping(params = {}) ⇒ Types::BasePathMapping

Changes information about the BasePathMapping resource.

Examples:

Request syntax with placeholder values


resp = client.update_base_path_mapping({
  domain_name: "String", # required
  base_path: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.base_path #=> String
resp.rest_api_id #=> String
resp.stage #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The domain name of the BasePathMapping resource to change.

  • :base_path (required, String)

    The base path of the BasePathMapping resource to change.

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



4804
4805
4806
4807
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4804

def update_base_path_mapping(params = {}, options = {})
  req = build_request(:update_base_path_mapping, params)
  req.send_request(options)
end

#update_client_certificate(params = {}) ⇒ Types::ClientCertificate

Changes information about an ClientCertificate resource.

Examples:

Request syntax with placeholder values


resp = client.update_client_certificate({
  client_certificate_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.client_certificate_id #=> String
resp.description #=> String
resp.pem_encoded_certificate #=> String
resp.created_date #=> Time
resp.expiration_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :client_certificate_id (required, String)

    The identifier of the ClientCertificate resource to be updated.

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



4850
4851
4852
4853
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4850

def update_client_certificate(params = {}, options = {})
  req = build_request(:update_client_certificate, params)
  req.send_request(options)
end

#update_deployment(params = {}) ⇒ Types::Deployment

Changes information about a Deployment resource.

Examples:

Request syntax with placeholder values


resp = client.update_deployment({
  rest_api_id: "String", # required
  deployment_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.description #=> String
resp.created_date #=> Time
resp.api_summary #=> Hash
resp.api_summary["String"] #=> Hash
resp.api_summary["String"]["String"].authorization_type #=> String
resp.api_summary["String"]["String"].api_key_required #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :deployment_id (required, String)

    The replacement identifier for the Deployment resource to change information about.

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



4902
4903
4904
4905
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4902

def update_deployment(params = {}, options = {})
  req = build_request(:update_deployment, params)
  req.send_request(options)
end

#update_documentation_part(params = {}) ⇒ Types::DocumentationPart

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.update_documentation_part({
  rest_api_id: "String", # required
  documentation_part_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
resp.location.path #=> String
resp.location.method #=> String
resp.location.status_code #=> String
resp.location.name #=> String
resp.properties #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :documentation_part_id (required, String)

    [Required] The identifier of the to-be-updated documentation part.

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



4950
4951
4952
4953
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4950

def update_documentation_part(params = {}, options = {})
  req = build_request(:update_documentation_part, params)
  req.send_request(options)
end

#update_documentation_version(params = {}) ⇒ Types::DocumentationVersion

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.update_documentation_version({
  rest_api_id: "String", # required
  documentation_version: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.version #=> String
resp.created_date #=> Time
resp.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi..

  • :documentation_version (required, String)

    [Required] The version identifier of the to-be-updated documentation version.

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



4995
4996
4997
4998
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4995

def update_documentation_version(params = {}, options = {})
  req = build_request(:update_documentation_version, params)
  req.send_request(options)
end

#update_domain_name(params = {}) ⇒ Types::DomainName

Changes information about the DomainName resource.

Examples:

Request syntax with placeholder values


resp = client.update_domain_name({
  domain_name: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.domain_name #=> String
resp.certificate_name #=> String
resp.certificate_arn #=> String
resp.certificate_upload_date #=> Time
resp.distribution_domain_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the DomainName resource to be changed.

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



5041
5042
5043
5044
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5041

def update_domain_name(params = {}, options = {})
  req = build_request(:update_domain_name, params)
  req.send_request(options)
end

#update_gateway_response(params = {}) ⇒ Types::GatewayResponse

Updates a GatewayResponse of a specified response type on the given RestApi.

Examples:

Request syntax with placeholder values


resp = client.update_gateway_response({
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.default_response #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    The string identifier of the associated RestApi.

  • :response_type (required, String)

    The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPES

  • :patch_operations (Array<Types::PatchOperation>)

    A list of update operations to be applied to the specified resource and in the order specified in this list.

Returns:



5114
5115
5116
5117
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5114

def update_gateway_response(params = {}, options = {})
  req = build_request(:update_gateway_response, params)
  req.send_request(options)
end

#update_integration(params = {}) ⇒ Types::Integration

Represents an update integration.

Examples:

Request syntax with placeholder values


resp = client.update_integration({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.http_method #=> String
resp.uri #=> String
resp.credentials #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> String
resp.request_templates #=> Hash
resp.request_templates["String"] #=> String
resp.passthrough_behavior #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.cache_namespace #=> String
resp.cache_key_parameters #=> Array
resp.cache_key_parameters[0] #=> String
resp.integration_responses #=> Hash
resp.integration_responses["String"].status_code #=> String
resp.integration_responses["String"].selection_pattern #=> String
resp.integration_responses["String"].