/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ApiGateway::GetExport

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $apigateway = Paws->service('ApiGateway');
my $ExportResponse = $apigateway->GetExport(
  ExportType => 'MyString',
  RestApiId  => 'MyString',
  StageName  => 'MyString',
  Accepts    => 'MyString',                       # OPTIONAL
  Parameters => { 'MyString' => 'MyString', },    # OPTIONAL
);

# Results:
my $Body               = $ExportResponse->Body;
my $ContentDisposition = $ExportResponse->ContentDisposition;
my $ContentType        = $ExportResponse->ContentType;

# Returns a L<Paws::ApiGateway::ExportResponse> 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/GetExport

ATTRIBUTES

Accepts => Str

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

REQUIRED ExportType => Str

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Parameters => Paws::ApiGateway::MapOfStringToString

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

REQUIRED StageName => Str

[Required] The name of the Stage that will be exported.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetExport 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