APIGateway / Client / update_rest_api

update_rest_api#

APIGateway.Client.update_rest_api(**kwargs)#

Changes information about the specified API.

See also: AWS API Documentation

Request Syntax

response = client.update_rest_api(
    restApiId='string',
    patchOperations=[
        {
            'op': 'add'|'remove'|'replace'|'move'|'copy'|'test',
            'path': 'string',
            'value': 'string',
            'from': 'string'
        },
    ]
)
Parameters:

  • restApiId (string) –

    [REQUIRED]

    The string identifier of the associated RestApi.

  • patchOperations (list) –

    For more information about supported patch operations, see Patch Operations.

    • (dict) –

      For more information about supported patch operations, see Patch Operations.

      • op (string) –

        An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message..

      • path (string) –

        The op operation’s target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {“name”:”value”}, the path for this property is /name. If the name property value is a JSON object (e.g., {“name”: {“child/name”: “child-value”}}), the path for the child/name property will be /name/child~1name. Any slash (“/”) character appearing in path names must be escaped with “~1”, as shown in the example above. Each op operation can have only one path associated with it.

      • value (string) –

        The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., ‘{“a”: …}’.

      • from (string) –

        The copy update operation’s source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with “op”:”copy”, “from”:”/canarySettings/deploymentId” and “path”:”/deploymentId”.

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,
    'rootResourceId': 'string'
}

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.

    • rootResourceId (string) –

      The API’s root resource ID.

Exceptions