Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ApiGatewayV2.ExportApi

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

- | Undocumented operation.

Synopsis

data ExportApi = ExportApi' {
- exportVersion :: Maybe Text
- includeExtensions :: Maybe Bool
- stageName :: Maybe Text
- specification :: Text
- outputType :: Text
- apiId :: Text
}
newExportApi :: Text -> Text -> Text -> ExportApi
exportApi_exportVersion :: Lens' ExportApi (Maybe Text)
exportApi_includeExtensions :: Lens' ExportApi (Maybe Bool)
exportApi_stageName :: Lens' ExportApi (Maybe Text)
exportApi_specification :: Lens' ExportApi Text
exportApi_outputType :: Lens' ExportApi Text
exportApi_apiId :: Lens' ExportApi Text
data ExportApiResponse = ExportApiResponse' {
- body :: Maybe ByteString
- httpStatus :: Int
}
newExportApiResponse :: Int -> ExportApiResponse
exportApiResponse_body :: Lens' ExportApiResponse (Maybe ByteString)
exportApiResponse_httpStatus :: Lens' ExportApiResponse Int

Creating a Request

data ExportApi Source #

See: newExportApi smart constructor.

Constructors

ExportApi'

Fields

exportVersion :: Maybe Text
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 :: Maybe Bool
Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
stageName :: Maybe Text
The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
specification :: Text
The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
outputType :: Text
The output type of the exported definition file. Valid values are JSON and YAML.
apiId :: Text
The API identifier.

Instances

Instances details

ToHeaders ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods toHeaders :: ExportApi -> [Header] #
ToPath ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods toPath :: ExportApi -> ByteString #
ToQuery ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods toQuery :: ExportApi -> QueryString #
AWSRequest ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Associated Types type AWSResponse ExportApi # Methods request :: (Service -> Service) -> ExportApi -> Request ExportApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ExportApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExportApi))) #
Generic ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Associated Types type Rep ExportApi :: Type -> Type # Methods from :: ExportApi -> Rep ExportApi x # to :: Rep ExportApi x -> ExportApi #
Read ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods readsPrec :: Int -> ReadS ExportApi # readList :: ReadS [ExportApi] # readPrec :: ReadPrec ExportApi # readListPrec :: ReadPrec [ExportApi] #
Show ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods showsPrec :: Int -> ExportApi -> ShowS # show :: ExportApi -> String # showList :: [ExportApi] -> ShowS #
NFData ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods rnf :: ExportApi -> () #
Eq ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods (==) :: ExportApi -> ExportApi -> Bool # (/=) :: ExportApi -> ExportApi -> Bool #
Hashable ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods hashWithSalt :: Int -> ExportApi -> Int # hash :: ExportApi -> Int #
type AWSResponse ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi type AWSResponse ExportApi = ExportApiResponse
type Rep ExportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi type Rep ExportApi = D1 ('MetaData "ExportApi" "Amazonka.ApiGatewayV2.ExportApi" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "ExportApi'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exportVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "includeExtensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "specification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "outputType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newExportApi Source #

Arguments

:: Text	`$sel:specification:ExportApi'`
-> Text	`$sel:outputType:ExportApi'`
-> Text	`ExportApi`
-> ExportApi

Create a value of ExportApi 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:exportVersion:ExportApi', exportApi_exportVersion - The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

$sel:includeExtensions:ExportApi', exportApi_includeExtensions - Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

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

$sel:specification:ExportApi', exportApi_specification - The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

$sel:outputType:ExportApi', exportApi_outputType - The output type of the exported definition file. Valid values are JSON and YAML.

ExportApi, exportApi_apiId - The API identifier.

Request Lenses

exportApi_exportVersion :: Lens' ExportApi (Maybe Text) Source #

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

exportApi_includeExtensions :: Lens' ExportApi (Maybe Bool) Source #

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

exportApi_stageName :: Lens' ExportApi (Maybe Text) Source #

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

exportApi_specification :: Lens' ExportApi Text Source #

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

exportApi_outputType :: Lens' ExportApi Text Source #

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

exportApi_apiId :: Lens' ExportApi Text Source #

The API identifier.

Destructuring the Response

data ExportApiResponse Source #

See: newExportApiResponse smart constructor.

Constructors

ExportApiResponse'
Fields body :: Maybe ByteString httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ExportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Associated Types type Rep ExportApiResponse :: Type -> Type # Methods from :: ExportApiResponse -> Rep ExportApiResponse x # to :: Rep ExportApiResponse x -> ExportApiResponse #
Read ExportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods readsPrec :: Int -> ReadS ExportApiResponse # readList :: ReadS [ExportApiResponse] # readPrec :: ReadPrec ExportApiResponse # readListPrec :: ReadPrec [ExportApiResponse] #
Show ExportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods showsPrec :: Int -> ExportApiResponse -> ShowS # show :: ExportApiResponse -> String # showList :: [ExportApiResponse] -> ShowS #
NFData ExportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods rnf :: ExportApiResponse -> () #
Eq ExportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi Methods (==) :: ExportApiResponse -> ExportApiResponse -> Bool # (/=) :: ExportApiResponse -> ExportApiResponse -> Bool #
type Rep ExportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ExportApi type Rep ExportApiResponse = D1 ('MetaData "ExportApiResponse" "Amazonka.ApiGatewayV2.ExportApi" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "ExportApiResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newExportApiResponse Source #

Arguments

:: Int	`$sel:httpStatus:ExportApiResponse'`
-> ExportApiResponse

Create a value of ExportApiResponse 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:ExportApiResponse', exportApiResponse_body - Undocumented member.

$sel:httpStatus:ExportApiResponse', exportApiResponse_httpStatus - The response's http status code.

Response Lenses

exportApiResponse_body :: Lens' ExportApiResponse (Maybe ByteString) Source #

Undocumented member.

exportApiResponse_httpStatus :: Lens' ExportApiResponse Int Source #

The response's http status code.