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


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

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


    my $apigateway = Paws->service('ApiGateway');
    my $RestApi = $apigateway->PutRestApi(
      Body           => 'BlobBlob',
      RestApiId      => 'MyString',
      FailOnWarnings => 1,                                # OPTIONAL
      Mode           => 'merge',                          # OPTIONAL
      Parameters     => { 'MyString' => 'MyString', },    # OPTIONAL

    # Results:
    my $ApiKeySource           = $RestApi->ApiKeySource;
    my $BinaryMediaTypes       = $RestApi->BinaryMediaTypes;
    my $CreatedDate            = $RestApi->CreatedDate;
    my $Description            = $RestApi->Description;
    my $EndpointConfiguration  = $RestApi->EndpointConfiguration;
    my $Id                     = $RestApi->Id;
    my $MinimumCompressionSize = $RestApi->MinimumCompressionSize;
    my $Name                   = $RestApi->Name;
    my $Policy                 = $RestApi->Policy;
    my $Tags                   = $RestApi->Tags;
    my $Version                = $RestApi->Version;
    my $Warnings               = $RestApi->Warnings;

    # Returns a L<Paws::ApiGateway::RestApi> 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


REQUIRED Body => Str

[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 2MB.

FailOnWarnings => Bool

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.

Mode => Str

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Valid values are: "merge", "overwrite"

Parameters => Paws::ApiGateway::MapOfStringToString

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

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.


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


The source code is located here:

Please report bugs to: