Class: Aws::APIGateway::Client

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

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

  The string identifier of the associated RestApi.

• :name (required, String) —

  The name of the authorizer.

• :type (required, String) —

  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 OpenAPI 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. For COGNITO_USER_POOLS authorizers, 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:

• (Types::Authorizer) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #name => String
  • #type => String
  • #provider_arns => Array<String>
  • #auth_type => String
  • #authorizer_uri => String
  • #authorizer_credentials => String
  • #identity_source => String
  • #identity_validation_expression => String
  • #authorizer_result_ttl_in_seconds => Integer

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

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

Parameters:

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

  ({})

Options Hash (params):

• :domain_name (required, String) —

  The domain name of the BasePathMapping resource to create.

• :domain_name_id (String) —

  The identifier for the domain name resource. Required for private custom domain names.

• :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. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

• :rest_api_id (required, String) —

  The string identifier of the associated RestApi.

• :stage (String) —

  The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

Returns:

• (Types::BasePathMapping) —

  Returns a response object which responds to the following methods:

  • #base_path => String
  • #rest_api_id => String
  • #stage => String

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,
  },
  tracing_enabled: false,
})

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

Parameters:

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

  ({})

Options Hash (params):

• :rest_api_id (required, String) —

  The string identifier of the associated RestApi.

• :stage_name (String) —

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

• :stage_description (String) —

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

• :description (String) —

  The description for the Deployment resource to create.

• :cache_cluster_enabled (Boolean) —

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

• :cache_cluster_size (String) —

  The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

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

• :tracing_enabled (Boolean) —

  Specifies whether active tracing with X-ray is enabled for the Stage.

Returns:

• (Types::Deployment) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #description => String
  • #created_date => Time
  • #api_summary => Hash<String,Hash<String,Types::MethodSnapshot>>

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

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

  The string identifier of the associated RestApi.

• :location (required, Types::DocumentationPartLocation) —

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

• :properties (required, String) —

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

Returns:

• (Types::DocumentationPart) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #location => Types::DocumentationPartLocation
  • #properties => String

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

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

Parameters:

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

  ({})

Options Hash (params):

• :rest_api_id (required, String) —

  The string identifier of the associated RestApi.

• :documentation_version (required, String) —

  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:

• (Types::DocumentationVersion) —

  Returns a response object which responds to the following methods:

  • #version => String
  • #created_date => Time
  • #description => String

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
    ip_address_type: "ipv4", # accepts ipv4, dualstack
    vpc_endpoint_ids: ["String"],
  },
  tags: {
    "String" => "String",
  },
  security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
  mutual_tls_authentication: {
    truststore_uri: "String",
    truststore_version: "String",
  },
  ownership_verification_certificate_arn: "String",
  policy: "String",
  routing_mode: "BASE_PATH_MAPPING_ONLY", # accepts BASE_PATH_MAPPING_ONLY, ROUTING_RULE_ONLY, ROUTING_RULE_THEN_BASE_PATH_MAPPING
})

resp.domain_name #=> String
resp.domain_name_id #=> String
resp.domain_name_arn #=> 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"
resp.endpoint_configuration.ip_address_type #=> String, one of "ipv4", "dualstack"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION"
resp.domain_name_status_message #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.mutual_tls_authentication.truststore_uri #=> String
resp.mutual_tls_authentication.truststore_version #=> String
resp.mutual_tls_authentication.truststore_warnings #=> Array
resp.mutual_tls_authentication.truststore_warnings[0] #=> String
resp.ownership_verification_certificate_arn #=> String
resp.management_policy #=> String
resp.policy #=> String
resp.routing_mode #=> String, one of "BASE_PATH_MAPPING_ONLY", "ROUTING_RULE_ONLY", "ROUTING_RULE_THEN_BASE_PATH_MAPPING"

Parameters:

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

  ({})

Options Hash (params):

• :domain_name (required, String) —

  The name of the DomainName resource.

• :certificate_name (String) —

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

• :certificate_body (String) —

  [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private 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 Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. 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 Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.

• :endpoint_configuration (Types::EndpointConfiguration) —

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

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

• :security_policy (String) —

  The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

• :mutual_tls_authentication (Types::MutualTlsAuthenticationInput) —

  The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

• :ownership_verification_certificate_arn (String) —

  The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

• :policy (String) —

  A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.

• :routing_mode (String) —

  The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.

Returns:

• (Types::DomainName) —

  Returns a response object which responds to the following methods:

  • #domain_name => String
  • #domain_name_id => String
  • #domain_name_arn => String
  • #certificate_name => String
  • #certificate_arn => String
  • #certificate_upload_date => Time
  • #regional_domain_name => String
  • #regional_hosted_zone_id => String
  • #regional_certificate_name => String
  • #regional_certificate_arn => String
  • #distribution_domain_name => String
  • #distribution_hosted_zone_id => String
  • #endpoint_configuration => Types::EndpointConfiguration
  • #domain_name_status => String
  • #domain_name_status_message => String
  • #security_policy => String
  • #tags => Hash<String,String>
  • #mutual_tls_authentication => Types::MutualTlsAuthentication
  • #ownership_verification_certificate_arn => String
  • #management_policy => String
  • #policy => String
  • #routing_mode => String

resp = client.create_domain_name_access_association({
  domain_name_arn: "String", # required
  access_association_source_type: "VPCE", # required, accepts VPCE
  access_association_source: "String", # required
  tags: {
    "String" => "String",
  },
})

resp.domain_name_access_association_arn #=> String
resp.domain_name_arn #=> String
resp.access_association_source_type #=> String, one of "VPCE"
resp.access_association_source #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

  ({})

Options Hash (params):

• :domain_name_arn (required, String) —

  The ARN of the domain name.

• :access_association_source_type (required, String) —

  The type of the domain name access association source.

• :access_association_source (required, String) —

  The identifier of the domain name access association source. For a VPCE, the value is the VPC endpoint ID.

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

• (Types::DomainNameAccessAssociation) —

  Returns a response object which responds to the following methods:

  • #domain_name_access_association_arn => String
  • #domain_name_arn => String
  • #access_association_source_type => String
  • #access_association_source => String
  • #tags => Hash<String,String>

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

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

Parameters:

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

  ({})

Options Hash (params):

• :rest_api_id (required, String) —

  The RestApi identifier under which the Model will be created.

• :name (required, String) —

  The name of the model. 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. The maximum size of the model is 400 KB.

• :content_type (required, String) —

  The content-type for the model.

Returns:

• (Types::Model) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #name => String
  • #description => String
  • #schema => String
  • #content_type => String

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

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

Parameters:

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

  ({})

Options Hash (params):

• :rest_api_id (required, String) —

  The string identifier of the associated RestApi.

• :name (String) —

  The name of the to-be-created RequestValidator.

• :validate_request_body (Boolean) —

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

• :validate_request_parameters (Boolean) —

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

Returns:

• (Types::RequestValidator) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #name => String
  • #validate_request_body => Boolean
  • #validate_request_parameters => Boolean

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

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"].method_integration.tls_config.insecure_skip_verification #=> Boolean
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) —

  The string identifier of the associated RestApi.

• :parent_id (required, String) —

  The parent resource's identifier.

• :path_part (required, String) —

  The last path segment for this resource.

Returns:

• (Types::Resource) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #parent_id => String
  • #path_part => String
  • #path => String
  • #resource_methods => Hash<String,Types::Method>

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
    ip_address_type: "ipv4", # accepts ipv4, dualstack
    vpc_endpoint_ids: ["String"],
  },
  policy: "String",
  tags: {
    "String" => "String",
  },
  disable_execute_api_endpoint: false,
})

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.endpoint_configuration.ip_address_type #=> String, one of "ipv4", "dualstack"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.policy #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.disable_execute_api_endpoint #=> Boolean
resp.root_resource_id #=> String

Parameters:

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

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the RestApi.

• :description (String) —

  The description of the RestApi.

• :version (String) —

  A version identifier for the API.

• :clone_from (String) —

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

• :binary_media_types (Array<String>) —

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

• :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 and IP address types of the API.

• :policy (String) —

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

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

• :disable_execute_api_endpoint (Boolean) —

  Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint

Returns:

• (Types::RestApi) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #name => String
  • #description => String
  • #created_date => Time
  • #version => String
  • #warnings => Array<String>
  • #binary_media_types => Array<String>
  • #minimum_compression_size => Integer
  • #api_key_source => String
  • #endpoint_configuration => Types::EndpointConfiguration
  • #policy => String
  • #tags => Hash<String,String>
  • #disable_execute_api_endpoint => Boolean
  • #root_resource_id => String

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,
  },
  tracing_enabled: false,
  tags: {
    "String" => "String",
  },
})

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.tracing_enabled #=> Boolean
resp.web_acl_arn #=> String
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) —

  The string identifier of the associated RestApi.

• :stage_name (required, String) —

  The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

• :deployment_id (required, String) —

  The identifier of the Deployment resource for the Stage resource.

• :description (String) —

  The description of the Stage resource.

• :cache_cluster_enabled (Boolean) —

  Whether cache clustering is enabled for the stage.

• :cache_cluster_size (String) —

  The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

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

• :tracing_enabled (Boolean) —

  Specifies whether active tracing with X-ray is enabled for the 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:

• (Types::Stage) —

  Returns a response object which responds to the following methods:

  • #deployment_id => String
  • #client_certificate_id => String
  • #stage_name => String
  • #description => String
  • #cache_cluster_enabled => Boolean
  • #cache_cluster_size => String
  • #cache_cluster_status => String
  • #method_settings => Hash<String,Types::MethodSetting>
  • #variables => Hash<String,String>
  • #documentation_version => String
  • #access_log_settings => Types::AccessLogSettings
  • #canary_settings => Types::CanarySettings
  • #tracing_enabled => Boolean
  • #web_acl_arn => String
  • #tags => Hash<String,String>
  • #created_date => Time
  • #last_updated_date => Time

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
  },
  tags: {
    "String" => "String",
  },
})

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
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

  ({})

Options Hash (params):

• :name (required, String) —

  The name of the usage plan.

• :description (String) —

  The description of the usage plan.

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

  The associated API stages of the usage plan.

• :throttle (Types::ThrottleSettings) —

  The throttling limits of the usage plan.

• :quota (Types::QuotaSettings) —

  The quota of the usage plan.

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

• (Types::UsagePlan) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #name => String
  • #description => String
  • #api_stages => Array<Types::ApiStage>
  • #throttle => Types::ThrottleSettings
  • #quota => Types::QuotaSettings
  • #product_code => String
  • #tags => Hash<String,String>

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

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

Parameters:

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

  ({})

Options Hash (params):

• :usage_plan_id (required, String) —

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

• :key_id (required, String) —

  The identifier of a UsagePlanKey resource for a plan customer.

• :key_type (required, String) —

  The type of a UsagePlanKey resource for a plan customer.

Returns:

• (Types::UsagePlanKey) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #type => String
  • #value => String
  • #name => String

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

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
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

  ({})

Options Hash (params):

• :name (required, String) —

  The name used to label and identify the VPC link.

• :description (String) —

  The description of the VPC link.

• :target_arns (required, Array<String>) —

  The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.

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

• (Types::VpcLink) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #name => String
  • #description => String
  • #target_arns => Array<String>
  • #status => String
  • #status_message => String
  • #tags => Hash<String,String>

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

Parameters:

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

  ({})

Options Hash (params):

• :api_key (required, String) —

  The identifier of the ApiKey resource to be deleted.

Returns:

• (Struct) —

  Returns an empty response.

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

Parameters:

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

  ({})

Options Hash (params):

• :rest_api_id (required, String) —

  The string identifier of the associated RestApi.

• :authorizer_id (required, String) —

  The identifier of the Authorizer resource.

Returns:

• (Struct) —

  Returns an empty response.