/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ApiGatewayV2::ExportApi

NAME

Paws::ApiGatewayV2::ExportApi - Arguments for method ExportApi on Paws::ApiGatewayV2

DESCRIPTION

This class represents the parameters used for calling the method ExportApi on the AmazonApiGatewayV2 service. Use the attributes of this class as arguments to method ExportApi.

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

SYNOPSIS

my $apigateway = Paws->service('ApiGatewayV2');
my $ExportApiResponse = $apigateway->ExportApi(
  ApiId             => 'My__string',
  OutputType        => 'My__string',
  Specification     => 'My__string',
  ExportVersion     => 'My__string',    # OPTIONAL
  IncludeExtensions => 1,               # OPTIONAL
  StageName         => 'My__string',    # OPTIONAL
);

# Results:
my $Body = $ExportApiResponse->Body;

# Returns a L<Paws::ApiGatewayV2::ExportApiResponse> 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/ExportApi

ATTRIBUTES

REQUIRED ApiId => Str

The API identifier.

ExportVersion => Str

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

IncludeExtensions => Bool

Specifies whether to include API Gateway extensions (https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html) in the exported API definition. API Gateway extensions are included by default.

REQUIRED OutputType => Str

The output type of the exported definition file. Valid values are JSON and YAML.

REQUIRED Specification => Str

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

StageName => Str

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

SEE ALSO

This class forms part of Paws, documenting arguments for method ExportApi in Paws::ApiGatewayV2

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