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

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



155
156
157
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 155

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:



239
240
241
242
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 239

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, REQUEST, COGNITO_USER_POOLS
  provider_arns: ["ProviderARN"],
  auth_type: "String",
  authorizer_uri: "String",
  authorizer_credentials: "String",
  identity_source: "String",
  identity_validation_expression: "String",
  authorizer_result_ttl_in_seconds: 1,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type #=> String, one of "TOKEN", "REQUEST", "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)

    [Required] The string identifier of the associated RestApi.

  • :name (required, String)

    [Required] The name of the authorizer.

  • :type (required, String)

    [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

  • :provider_arns (Array<String>)

    A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:\{region\}:\{account_id\}:userpool/\{user_pool_id\}. For a TOKEN or REQUEST authorizer, this is not defined.

  • :auth_type (String)

    Optional customer-defined field, used in Swagger imports and exports without functional impact.

  • :authorizer_uri (String)

    Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:\{account_id\}:function:\{lambda_function_name\}/invocations. In general, the URI has this form arn:aws:apigateway:\{region\}:lambda:path/\{service_api\}, where \{region\} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

  • :authorizer_credentials (String)

    Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

  • :identity_source (String)

    The identity source for which authorization is requested. * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. * For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

  • :identity_validation_expression (String)

    A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

  • :authorizer_result_ttl_in_seconds (Integer)

    The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Returns:



378
379
380
381
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 378

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)

    [Required] 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)

    [Required] 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:



426
427
428
429
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 426

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",
  },
  canary_settings: {
    percent_traffic: 1.0,
    stage_variable_overrides: {
      "String" => "String",
    },
    use_stage_cache: false,
  },
})

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)

    [Required] 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-._~:/?#&=,]+.

  • :canary_settings (Types::DeploymentCanarySettings)

    The input configuration for the canary deployment when the deployment is a canary release deployment.

Returns:



504
505
506
507
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 504

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:



554
555
556
557
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 554

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:



594
595
596
597
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 594

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",
  regional_certificate_name: "String",
  regional_certificate_arn: "String",
  endpoint_configuration: {
    types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
  },
})

Response structure


resp.domain_name #=> String
resp.certificate_name #=> String
resp.certificate_arn #=> String
resp.certificate_upload_date #=> Time
resp.regional_domain_name #=> String
resp.regional_hosted_zone_id #=> String
resp.regional_certificate_name #=> String
resp.regional_certificate_arn #=> String
resp.distribution_domain_name #=> String
resp.distribution_hosted_zone_id #=> String
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    [Required] The name of the DomainName resource.

  • :certificate_name (String)

    The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

  • :certificate_body (String)

    [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

  • :certificate_private_key (String)

    [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

  • :certificate_chain (String)

    [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. 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 that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

  • :regional_certificate_name (String)

    The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

  • :regional_certificate_arn (String)

    The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

  • :endpoint_configuration (Types::EndpointConfiguration)

    The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Returns:



691
692
693
694
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 691

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)

    [Required] The RestApi identifier under which the Model will be created.

  • :name (required, String)

    [Required] The name of the model. Must be alphanumeric.

  • :description (String)

    The description of the model.

  • :schema (String)

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

  • :content_type (required, String)

    [Required] The content-type for the model.

Returns:



747
748
749
750
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 747

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)

    [Required] 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:



794
795
796
797
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 794

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.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.resource_methods["String"].method_integration.connection_id #=> 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.timeout_in_millis #=> Integer
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"
resp.resource_methods["String"].authorization_scopes #=> Array
resp.resource_methods["String"].authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :parent_id (required, String)

    [Required] The parent resource's identifier.

  • :path_part (required, String)

    The last path segment for this resource.

Returns:



878
879
880
881
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 878

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"],
  minimum_compression_size: 1,
  api_key_source: "HEADER", # accepts HEADER, AUTHORIZER
  endpoint_configuration: {
    types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
  },
  policy: "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
resp.minimum_compression_size #=> Integer
resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    [Required] 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.

  • :minimum_compression_size (Integer)

    A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

  • :api_key_source (String)

    The source of the API key for metering requests according to a usage plan. Valid values are: * HEADER to read the API key from the X-API-Key header of a request. * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

  • :endpoint_configuration (Types::EndpointConfiguration)

    The endpoint configuration of this RestApi showing the endpoint types of the API.

  • :policy (String)

    A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Returns:



973
974
975
976
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 973

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",
  canary_settings: {
    percent_traffic: 1.0,
    deployment_id: "String",
    stage_variable_overrides: {
      "String" => "String",
    },
    use_stage_cache: false,
  },
  tags: {
    "String" => "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.access_log_settings.format #=> String
resp.access_log_settings.destination_arn #=> String
resp.canary_settings.percent_traffic #=> Float
resp.canary_settings.deployment_id #=> String
resp.canary_settings.stage_variable_overrides #=> Hash
resp.canary_settings.stage_variable_overrides["String"] #=> String
resp.canary_settings.use_stage_cache #=> Boolean
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String)

    [Required] The name for the Stage resource.

  • :deployment_id (required, String)

    [Required] 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.

  • :canary_settings (Types::CanarySettings)

    The canary deployment settings of this stage.

  • :tags (Hash<String,String>)

    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Returns:



1097
1098
1099
1100
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1097

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: {
        "String" => {
          burst_limit: 1,
          rate_limit: 1.0,
        },
      },
    },
  ],
  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.api_stages[0].throttle #=> Hash
resp.api_stages[0].throttle["String"].burst_limit #=> Integer
resp.api_stages[0].throttle["String"].rate_limit #=> Float
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)

    [Required] 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:



1178
1179
1180
1181
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1178

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)

    [Required] 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)

    [Required] The identifier of a UsagePlanKey resource for a plan customer.

  • :key_type (required, String)

    [Required] The type of a UsagePlanKey resource for a plan customer.

Returns:



1222
1223
1224
1225
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1222

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

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

Examples:

Request syntax with placeholder values


resp = client.create_vpc_link({
  name: "String", # required
  description: "String",
  target_arns: ["String"], # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.target_arns #=> Array
resp.target_arns[0] #=> String
resp.status #=> String, one of "AVAILABLE", "PENDING", "DELETING", "FAILED"
resp.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    [Required] The name used to label and identify the VPC link.

  • :description (String)

    The description of the VPC link.

  • :target_arns (required, Array<String>)

    [Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.

Returns:



1272
1273
1274
1275
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1272

def create_vpc_link(params = {}, options = {})
  req = build_request(:create_vpc_link, 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)

    [Required] The identifier of the ApiKey resource to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1292
1293
1294
1295
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1292

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)

    [Required] The string identifier of the associated RestApi.

  • :authorizer_id (required, String)

    [Required] The identifier of the Authorizer resource.

Returns:

  • (Struct)

    Returns an empty response.



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

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)

    [Required] The domain name of the BasePathMapping resource to delete.

  • :base_path (required, String)

    [Required] The base path name of the BasePathMapping resource to delete.

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_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)

    [Required] The identifier of the ClientCertificate resource to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1371
1372
1373
1374
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1371

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)

    [Required] The string identifier of the associated RestApi.

  • :deployment_id (required, String)

    [Required] The identifier of the Deployment resource to delete.

Returns:

  • (Struct)

    Returns an empty response.



1396
1397
1398
1399
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1396

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.



1418
1419
1420
1421
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1418

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.



1441
1442
1443
1444
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1441

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)

    [Required] The name of the DomainName resource to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1461
1462
1463
1464
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1461

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)

    [Required] The string identifier of the associated RestApi.

  • :response_type (required, String)

    [Required] 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_TYPE

Returns:

  • (Struct)

    Returns an empty response.



1507
1508
1509
1510
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1507

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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] Specifies a delete integration request's resource identifier.

  • :http_method (required, String)

    [Required] Specifies a delete integration request's HTTP method.

Returns:

  • (Struct)

    Returns an empty response.



1536
1537
1538
1539
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1536

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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] Specifies a delete integration response request's resource identifier.

  • :http_method (required, String)

    [Required] Specifies a delete integration response request's HTTP method.

  • :status_code (required, String)

    [Required] Specifies a delete integration response request's status code.

Returns:

  • (Struct)

    Returns an empty response.



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

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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] The Resource identifier for the Method resource.

  • :http_method (required, String)

    [Required] The HTTP verb of the Method resource.

Returns:

  • (Struct)

    Returns an empty response.



1599
1600
1601
1602
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1599

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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] The Resource identifier for the MethodResponse resource.

  • :http_method (required, String)

    [Required] The HTTP verb of the Method resource.

  • :status_code (required, String)

    [Required] The status code identifier for the MethodResponse resource.

Returns:

  • (Struct)

    Returns an empty response.



1632
1633
1634
1635
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1632

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)

    [Required] The string identifier of the associated RestApi.

  • :model_name (required, String)

    [Required] The name of the model to delete.

Returns:

  • (Struct)

    Returns an empty response.



1656
1657
1658
1659
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1656

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)

    [Required] 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.



1680
1681
1682
1683
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1680

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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] The identifier of the Resource resource.

Returns:

  • (Struct)

    Returns an empty response.



1704
1705
1706
1707
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1704

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)

    [Required] The string identifier of the associated RestApi.

Returns:

  • (Struct)

    Returns an empty response.



1724
1725
1726
1727
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1724

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)

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String)

    [Required] The name of the Stage resource to delete.

Returns:

  • (Struct)

    Returns an empty response.



1748
1749
1750
1751
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1748

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)

    [Required] The Id of the to-be-deleted usage plan.

Returns:

  • (Struct)

    Returns an empty response.



1768
1769
1770
1771
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1768

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)

    [Required] 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)

    [Required] The Id of the UsagePlanKey resource to be deleted.

Returns:

  • (Struct)

    Returns an empty response.



1795
1796
1797
1798
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1795

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

Deletes an existing VpcLink of a specified identifier.

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_link({
  vpc_link_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_link_id (required, String)

    [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Returns:

  • (Struct)

    Returns an empty response.



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

def delete_vpc_link(params = {}, options = {})
  req = build_request(:delete_vpc_link, 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.



1840
1841
1842
1843
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1840

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)

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String)

    [Required] The name of the stage to flush its cache.

Returns:

  • (Struct)

    Returns an empty response.



1864
1865
1866
1867
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1864

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:



1898
1899
1900
1901
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1898

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:



1923
1924
1925
1926
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1923

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)

    [Required] 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:



1971
1972
1973
1974
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1971

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. The default value is 25 and the maximum value is 500.

  • :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:



2031
2032
2033
2034
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2031

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", "REQUEST", "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)

    [Required] The string identifier of the associated RestApi.

  • :authorizer_id (required, String)

    [Required] The identifier of the Authorizer resource.

Returns:



2088
2089
2090
2091
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2088

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", "REQUEST", "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)

    [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. The default value is 25 and the maximum value is 500.

Returns:



2144
2145
2146
2147
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2144

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)

    [Required] The domain name of the BasePathMapping resource to be described.

  • :base_path (required, String)

    [Required] 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:



2183
2184
2185
2186
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2183

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)

    [Required] 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 default value is 25 and the maximum value is 500.

Returns:



2223
2224
2225
2226
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2223

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)

    [Required] The identifier of the ClientCertificate resource to be described.

Returns:



2258
2259
2260
2261
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2258

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 default value is 25 and the maximum value is 500.

Returns:



2296
2297
2298
2299
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2296

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)

    [Required] The string identifier of the associated RestApi.

  • :deployment_id (required, String)

    [Required] 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:



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

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)

    [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. The default value is 25 and the maximum value is 500.

Returns:



2394
2395
2396
2397
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2394

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:



2430
2431
2432
2433
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2430

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,
  location_status: "DOCUMENTED", # accepts DOCUMENTED, UNDOCUMENTED
})

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. The default value is 25 and the maximum value is 500.

  • :location_status (String)

    The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Returns:



2491
2492
2493
2494
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2491

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:



2524
2525
2526
2527
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2524

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. The default value is 25 and the maximum value is 500.

Returns:



2562
2563
2564
2565
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2562

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.regional_domain_name #=> String
resp.regional_hosted_zone_id #=> String
resp.regional_certificate_name #=> String
resp.regional_certificate_arn #=> String
resp.distribution_domain_name #=> String
resp.distribution_hosted_zone_id #=> String
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    [Required] The name of the DomainName resource.

Returns:



2610
2611
2612
2613
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2610

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].regional_domain_name #=> String
resp.items[0].regional_hosted_zone_id #=> String
resp.items[0].regional_certificate_name #=> String
resp.items[0].regional_certificate_arn #=> String
resp.items[0].distribution_domain_name #=> String
resp.items[0].distribution_hosted_zone_id #=> String
resp.items[0].endpoint_configuration.types #=> Array
resp.items[0].endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"

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 default value is 25 and the maximum value is 500.

Returns:



2655
2656
2657
2658
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2655

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)

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String)

    [Required] The name of the Stage that will be exported.

  • :export_type (required, String)

    [Required] 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: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. 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:



2714
2715
2716
2717
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2714

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)

    [Required] The string identifier of the associated RestApi.

  • :response_type (required, String)

    [Required] 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_TYPE

Returns:



2776
2777
2778
2779
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2776

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 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)

    [Required] 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 default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

Returns:



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

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

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

Get the integration settings.

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.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.connection_id #=> 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.timeout_in_millis #=> Integer
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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] Specifies a get integration request's resource identifier

  • :http_method (required, String)

    [Required] Specifies a get integration request's HTTP method.

Returns:



2897
2898
2899
2900
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2897

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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] Specifies a get integration response request's resource identifier.

  • :http_method (required, String)

    [Required] Specifies a get integration response request's HTTP method.

  • :status_code (required, String)

    [Required] Specifies a get integration response request's status code.

Returns:



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

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.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.method_integration.connection_id #=> 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.timeout_in_millis #=> Integer
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"
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] The Resource identifier for the Method resource.

  • :http_method (required, String)

    [Required] Specifies the method request's HTTP method type.

Returns:



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

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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] The Resource identifier for the MethodResponse resource.

  • :http_method (required, String)

    [Required] The HTTP verb of the Method resource.

  • :status_code (required, String)

    [Required] The status code for the MethodResponse resource.

Returns:



3077
3078
3079
3080
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3077

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)

    [Required] The RestApi identifier under which the Model exists.

  • :model_name (required, String)

    [Required] 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:



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

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)

    [Required] The string identifier of the associated RestApi.

  • :model_name (required, String)

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

Returns:



3152
3153
3154
3155
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3152

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)

    [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. The default value is 25 and the maximum value is 500.

Returns:



3194
3195
3196
3197
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3194

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)

    [Required] The string identifier of the associated RestApi.

  • :request_validator_id (required, String)

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

Returns:



3230
3231
3232
3233
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3230

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)

    [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. The default value is 25 and the maximum value is 500.

Returns:



3271
3272
3273
3274
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3271

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.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.resource_methods["String"].method_integration.connection_id #=> 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.timeout_in_millis #=> Integer
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"
resp.resource_methods["String"].authorization_scopes #=> Array
resp.resource_methods["String"].authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] 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:



3361
3362
3363
3364
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3361

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.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.items[0].resource_methods["String"].method_integration.connection_id #=> 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.timeout_in_millis #=> Integer
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"
resp.items[0].resource_methods["String"].authorization_scopes #=> Array
resp.items[0].resource_methods["String"].authorization_scopes[0] #=> 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. The default value is 25 and the maximum value is 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:



3455
3456
3457
3458
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3455

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
resp.minimum_compression_size #=> Integer
resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

Returns:



3504
3505
3506
3507
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3504

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
resp.items[0].minimum_compression_size #=> Integer
resp.items[0].api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.items[0].endpoint_configuration.types #=> Array
resp.items[0].endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.items[0].policy #=> 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 default value is 25 and the maximum value is 500.

Returns:



3551
3552
3553
3554
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3551

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)

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String)

    [Required] The name of the Stage that the SDK will use.

  • :sdk_type (required, String)

    [Required] The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

  • :parameters (Hash<String,String>)

    A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.

Returns:



3603
3604
3605
3606
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3603

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)

    [Required] The identifier of the queried SdkType instance.

Returns:



3638
3639
3640
3641
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3638

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. The default value is 25 and the maximum value is 500.

Returns:



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

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.access_log_settings.format #=> String
resp.access_log_settings.destination_arn #=> String
resp.canary_settings.percent_traffic #=> Float
resp.canary_settings.deployment_id #=> String
resp.canary_settings.stage_variable_overrides #=> Hash
resp.canary_settings.stage_variable_overrides["String"] #=> String
resp.canary_settings.use_stage_cache #=> Boolean
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String)

    [Required] The name of the Stage resource to get information about.

Returns:



3753
3754
3755
3756
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3753

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].access_log_settings.format #=> String
resp.item[0].access_log_settings.destination_arn #=> String
resp.item[0].canary_settings.percent_traffic #=> Float
resp.item[0].canary_settings.deployment_id #=> String
resp.item[0].canary_settings.stage_variable_overrides #=> Hash
resp.item[0].canary_settings.stage_variable_overrides["String"] #=> String
resp.item[0].canary_settings.use_stage_cache #=> Boolean
resp.item[0].tags #=> Hash
resp.item[0].tags["String"] #=> 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)

    [Required] The string identifier of the associated RestApi.

  • :deployment_id (String)

    The stages' deployment identifiers.

Returns:



3815
3816
3817
3818
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3815

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

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

Gets the Tags collection for a given resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, Stage is the only taggable resource.

  • :position (String) — default: Not currently supported

    The current pagination position in the paged result set.

  • :limit (Integer) — default: Not currently supported

    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:



3854
3855
3856
3857
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3854

def get_tags(params = {}, options = {})
  req = build_request(:get_tags, 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)

    [Required] 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)

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

  • :end_date (required, String)

    [Required] 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. The default value is 25 and the maximum value is 500.

Returns:



3912
3913
3914
3915
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3912

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.api_stages[0].throttle #=> Hash
resp.api_stages[0].throttle["String"].burst_limit #=> Integer
resp.api_stages[0].throttle["String"].rate_limit #=> Float
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)

    [Required] The identifier of the UsagePlan resource to be retrieved.

Returns:



3958
3959
3960
3961
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3958

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)

    [Required] 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)

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

Returns:



3997
3998
3999
4000
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3997

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)

    [Required] 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. The default value is 25 and the maximum value is 500.

  • :name_query (String)

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

Returns:



4046
4047
4048
4049
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4046

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].api_stages[0].throttle #=> Hash
resp.items[0].api_stages[0].throttle["String"].burst_limit #=> Integer
resp.items[0].api_stages[0].throttle["String"].rate_limit #=> Float
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. The default value is 25 and the maximum value is 500.

Returns:



4098
4099
4100
4101
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4098

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

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

Examples:

Request syntax with placeholder values


resp = client.get_vpc_link({
  vpc_link_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.target_arns #=> Array
resp.target_arns[0] #=> String
resp.status #=> String, one of "AVAILABLE", "PENDING", "DELETING", "FAILED"
resp.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_link_id (required, String)

    [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Returns:



4136
4137
4138
4139
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4136

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

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

Examples:

Request syntax with placeholder values


resp = client.get_vpc_links({
  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].target_arns #=> Array
resp.items[0].target_arns[0] #=> String
resp.items[0].status #=> String, one of "AVAILABLE", "PENDING", "DELETING", "FAILED"
resp.items[0].status_message #=> 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 default value is 25 and the maximum value is 500.

Returns:



4177
4178
4179
4180
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4177

def get_vpc_links(params = {}, options = {})
  req = build_request(:get_vpc_links, 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:



4222
4223
4224
4225
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4222

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:



4268
4269
4270
4271
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4268

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 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
resp.minimum_compression_size #=> Integer
resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.policy #=> 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>)

    A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

    To exclude DocumentationParts from the import, set parameters as ignore=documentation.

    To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

    To handle imported basePath, set parameters as basePath=ignore, basePath=prepend or basePath=split.

    For example, the AWS CLI command to exclude documentation from the imported API is:

    aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
    

    The AWS CLI command to set the regional endpoint on the imported API is:

    aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
    
  • :body (required, String, IO)

    [Required] 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:



4356
4357
4358
4359
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4356

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)

    [Required] The string identifier of the associated RestApi.

  • :response_type (required, String)

    [Required] 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_TYPE

  • :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:



4436
4437
4438
4439
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4436

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",
  connection_type: "INTERNET", # accepts INTERNET, VPC_LINK
  connection_id: "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
  timeout_in_millis: 1,
})

Response structure


resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.http_method #=> String
resp.uri #=> String
resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.connection_id #=> 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.timeout_in_millis #=> Integer
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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] Specifies a put integration request's resource ID.

  • :http_method (required, String)

    [Required] Specifies a put integration request's HTTP method.

  • :type (required, String)

    [Required] 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 Uniform Resource Identifier (URI) of the integration endpoint.

    • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

    • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}. Here, \{Region\} is the API Gateway region (e.g., us-east-1); \{service\} is the name of the integrated AWS service (e.g., s3); and \{subdomain\} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action=\{name\}&\{p1\}=\{v1\}&p2=\{v2\}... query string. The ensuing \{service_api\} refers to a supported action \{name\} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\} or arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}

  • :connection_type (String)

    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

  • :connection_id (String)

    The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

  • :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.

  • :timeout_in_millis (Integer)

    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Returns:



4640
4641
4642
4643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4640

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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] Specifies a put integration response request's resource identifier.

  • :http_method (required, String)

    [Required] Specifies a put integration response request's HTTP method.

  • :status_code (required, String)

    [Required] 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:



4733
4734
4735
4736
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4733

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",
  authorization_scopes: ["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.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.method_integration.connection_id #=> 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.timeout_in_millis #=> Integer
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"
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] The Resource identifier for the new Method resource.

  • :http_method (required, String)

    [Required] Specifies the method request's HTTP method type.

  • :authorization_type (required, String)

    [Required] 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 or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

  • :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 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.

  • :authorization_scopes (Array<String>)

    A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Returns:



4885
4886
4887
4888
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4885

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)

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String)

    [Required] The Resource identifier for the Method resource.

  • :http_method (required, String)

    [Required] The HTTP verb of the Method resource.

  • :status_code (required, String)

    [Required] The method response's status code.

  • :response_parameters (Hash<String,Boolean>)

    A key-value map specifying required or optional response parameters that 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:



4956
4957
4958
4959
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4956

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 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
resp.minimum_compression_size #=> Integer
resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String)

    [Required] 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)

    [Required] 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:



5036
5037
5038
5039
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5036

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

#tag_resource(params = {}) ⇒ Struct

Adds or updates a tag on a given resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "String" => "String",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, Stage is the only taggable resource.

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

    [Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Returns:

  • (Struct)

    Returns an empty response.



5066
5067
5068
5069
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5066

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, 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)

    [Required] The string identifier of the associated RestApi.

  • :authorizer_id (required, String)

    [Required] 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.