NAME

Paws::ApiGateway::ImportDocumentationParts - Arguments for method ImportDocumentationParts on Paws::ApiGateway

DESCRIPTION

This class represents the parameters used for calling the method ImportDocumentationParts on the Amazon API Gateway service. Use the attributes of this class as arguments to method ImportDocumentationParts.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportDocumentationParts.

SYNOPSIS

    my $apigateway = Paws->service('ApiGateway');
    my $DocumentationPartIds = $apigateway->ImportDocumentationParts(
      Body           => 'BlobBlob',
      RestApiId      => 'MyString',
      FailOnWarnings => 1,            # OPTIONAL
      Mode           => 'merge',      # OPTIONAL
    );

    # Results:
    my $Ids      = $DocumentationPartIds->Ids;
    my $Warnings = $DocumentationPartIds->Warnings;

    # Returns a L<Paws::ApiGateway::DocumentationPartIds> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/apigateway/ImportDocumentationParts

ATTRIBUTES

REQUIRED Body => Str

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

FailOnWarnings => Bool

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.

Mode => Str

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.

Valid values are: "merge", "overwrite"

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

SEE ALSO

This class forms part of Paws, documenting arguments for method ImportDocumentationParts in Paws::ApiGateway

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues