Amazonka.APIGateway.GetExport

Exports a deployed version of a RestApi in a specified format.

Creating a Request

data GetExport

Request a new export of a RestApi for a particular Stage.

See: newGetExport smart constructor.

Constructors

GetExport'

Fields

• accepts :: Maybe Text

  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.

• parameters :: Maybe (HashMap Text Text)

  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

• restApiId :: Text

  The string identifier of the associated RestApi.

• stageName :: Text

  The name of the Stage that will be exported.

• exportType :: Text

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

Instances

ToHeaders GetExport

Defined in Amazonka.APIGateway.GetExport

Methods

toHeaders :: GetExport -> [Header]

ToPath GetExport

Defined in Amazonka.APIGateway.GetExport

Methods

toPath :: GetExport -> ByteString

ToQuery GetExport

Defined in Amazonka.APIGateway.GetExport

Methods

toQuery :: GetExport -> QueryString

AWSRequest GetExport

Defined in Amazonka.APIGateway.GetExport

Associated Types

type AWSResponse GetExport

Methods

request :: (Service -> Service) -> GetExport -> Request GetExport

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetExport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetExport)))

Generic GetExport

Defined in Amazonka.APIGateway.GetExport

Associated Types

type Rep GetExport :: Type -> Type

Methods

from :: GetExport -> Rep GetExport x

to :: Rep GetExport x -> GetExport

Read GetExport

Defined in Amazonka.APIGateway.GetExport

Methods

readsPrec :: Int -> ReadS GetExport

readList :: ReadS [GetExport]

readPrec :: ReadPrec GetExport

readListPrec :: ReadPrec [GetExport]

Show GetExport

Defined in Amazonka.APIGateway.GetExport

Methods

showsPrec :: Int -> GetExport -> ShowS

show :: GetExport -> String

showList :: [GetExport] -> ShowS

NFData GetExport

Defined in Amazonka.APIGateway.GetExport

Methods

rnf :: GetExport -> ()

Eq GetExport

Defined in Amazonka.APIGateway.GetExport

Methods

(==) :: GetExport -> GetExport -> Bool

(/=) :: GetExport -> GetExport -> Bool

Hashable GetExport

Defined in Amazonka.APIGateway.GetExport

Methods

hashWithSalt :: Int -> GetExport -> Int

hash :: GetExport -> Int

type AWSResponse GetExport

Defined in Amazonka.APIGateway.GetExport

type AWSResponse GetExport = GetExportResponse

type Rep GetExport

Defined in Amazonka.APIGateway.GetExport

type Rep GetExport = D1 ('MetaData "GetExport" "Amazonka.APIGateway.GetExport" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetExport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accepts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "exportType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetExport

Arguments

:: Text

GetExport

-> Text

GetExport

-> Text

$sel:exportType:GetExport'

-> GetExport

Create a value of GetExport with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accepts:GetExport', getExport_accepts - 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.

$sel:parameters:GetExport', getExport_parameters - 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

GetExport, getExport_restApiId - The string identifier of the associated RestApi.

GetExport, getExport_stageName - The name of the Stage that will be exported.

$sel:exportType:GetExport', getExport_exportType - The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Request Lenses

getExport_accepts :: Lens' GetExport (Maybe Text)

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.

getExport_parameters :: Lens' GetExport (Maybe (HashMap Text Text))

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

getExport_restApiId :: Lens' GetExport Text

The string identifier of the associated RestApi.

getExport_stageName :: Lens' GetExport Text

The name of the Stage that will be exported.

getExport_exportType :: Lens' GetExport Text

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

Destructuring the Response

data GetExportResponse

The binary blob response to GetExport, which contains the generated SDK.

See: newGetExportResponse smart constructor.

Constructors

GetExportResponse'

Fields

• body :: Maybe ByteString

  The binary blob response to GetExport, which contains the export.

• contentDisposition :: Maybe Text

  The content-disposition header value in the HTTP response.

• contentType :: Maybe Text

  The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetExportResponse

Defined in Amazonka.APIGateway.GetExport

Associated Types

type Rep GetExportResponse :: Type -> Type

Methods

from :: GetExportResponse -> Rep GetExportResponse x

to :: Rep GetExportResponse x -> GetExportResponse

Show GetExportResponse

Defined in Amazonka.APIGateway.GetExport

Methods

showsPrec :: Int -> GetExportResponse -> ShowS

show :: GetExportResponse -> String

showList :: [GetExportResponse] -> ShowS

NFData GetExportResponse

Defined in Amazonka.APIGateway.GetExport

Methods

rnf :: GetExportResponse -> ()

Eq GetExportResponse

Defined in Amazonka.APIGateway.GetExport

Methods

(==) :: GetExportResponse -> GetExportResponse -> Bool

(/=) :: GetExportResponse -> GetExportResponse -> Bool

type Rep GetExportResponse

Defined in Amazonka.APIGateway.GetExport

type Rep GetExportResponse = D1 ('MetaData "GetExportResponse" "Amazonka.APIGateway.GetExport" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetExportResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "contentDisposition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetExportResponse

Arguments

:: Int

$sel:httpStatus:GetExportResponse'

-> GetExportResponse

Create a value of GetExportResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:body:GetExportResponse', getExportResponse_body - The binary blob response to GetExport, which contains the export.

$sel:contentDisposition:GetExportResponse', getExportResponse_contentDisposition - The content-disposition header value in the HTTP response.

GetExportResponse, getExportResponse_contentType - The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

$sel:httpStatus:GetExportResponse', getExportResponse_httpStatus - The response's http status code.

Response Lenses

getExportResponse_body :: Lens' GetExportResponse (Maybe ByteString)

The binary blob response to GetExport, which contains the export.

getExportResponse_contentDisposition :: Lens' GetExportResponse (Maybe Text)

The content-disposition header value in the HTTP response.

getExportResponse_contentType :: Lens' GetExportResponse (Maybe Text)

The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

getExportResponse_httpStatus :: Lens' GetExportResponse Int

The response's http status code.