APIGateway / Client / import_documentation_parts

import_documentation_parts#

APIGateway.Client.import_documentation_parts(**kwargs)#

Imports documentation parts

See also: AWS API Documentation

Request Syntax

response = client.import_documentation_parts(
    restApiId='string',
    mode='merge'|'overwrite',
    failOnWarnings=True|False,
    body=b'bytes'|file
)
Parameters:

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

  • failOnWarnings (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 (bytes or seekable file-like object) –

    [REQUIRED]

    Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

Return type:

dict

Returns:

Response Syntax

{
    'ids': [
        'string',
    ],
    'warnings': [
        'string',
    ]
}

Response Structure

  • (dict) –

    A collection of the imported DocumentationPart identifiers.

    • ids (list) –

      A list of the returned documentation part identifiers.

      • (string) –

    • warnings (list) –

      A list of warning messages reported during import of documentation parts.

      • (string) –

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