APIGateway / Client / put_rest_api

put_rest_api

APIGateway.Client.put_rest_api(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_rest_api(
    restApiId='string',
    mode='merge'|'overwrite',
    failOnWarnings=True|False,
    parameters={
        'string': 'string'
    },
    body=b'bytes'|file
)

Parameters:

• restApiId (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”.

• failOnWarnings (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 (dict) –

  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'.

  • (string) –

    • (string) –

• body (bytes or seekable file-like object) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'description': 'string',
    'createdDate': datetime(2015, 1, 1),
    'version': 'string',
    'warnings': [
        'string',
    ],
    'binaryMediaTypes': [
        'string',
    ],
    'minimumCompressionSize': 123,
    'apiKeySource': 'HEADER'|'AUTHORIZER',
    'endpointConfiguration': {
        'types': [
            'REGIONAL'|'EDGE'|'PRIVATE',
        ],
        'vpcEndpointIds': [
            'string',
        ]
    },
    'policy': 'string',
    'tags': {
        'string': 'string'
    },
    'disableExecuteApiEndpoint': True|False
}

Response Structure

• (dict) –

  Represents a REST API.

  • id (string) –

    The API’s identifier. This identifier is unique across all of your APIs in API Gateway.

  • name (string) –

    The API’s name.

  • description (string) –

    The API’s description.

  • createdDate (datetime) –

    The timestamp when the API was created.

  • version (string) –

    A version identifier for the API.

  • warnings (list) –

    The warning messages reported when failonwarnings is turned on during API import.

    • (string) –

  • binaryMediaTypes (list) –

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

    • (string) –

  • minimumCompressionSize (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.

  • apiKeySource (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.

  • endpointConfiguration (dict) –

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

    • types (list) –

      A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

      • (string) –

        The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.

    • vpcEndpointIds (list) –

      A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

      • (string) –

  • policy (string) –

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

  • tags (dict) –

    The collection of tags. Each tag element is associated with a given resource.

    • (string) –

      • (string) –

  • disableExecuteApiEndpoint (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.

Exceptions

• APIGateway.Client.exceptions.BadRequestException

• APIGateway.Client.exceptions.ConflictException

• APIGateway.Client.exceptions.LimitExceededException

• APIGateway.Client.exceptions.NotFoundException

• APIGateway.Client.exceptions.UnauthorizedException

• APIGateway.Client.exceptions.TooManyRequestsException