Amazonka.APIGateway.GetRestApis

Lists the RestApis resources for your collection.

This operation returns paginated results.

Creating a Request

data GetRestApis

The GET request to list existing RestApis defined for your collection.

See: newGetRestApis smart constructor.

Constructors

GetRestApis'

Fields

• limit :: Maybe Int

  The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

• position :: Maybe Text

  The current pagination position in the paged result set.

Instances

ToHeaders GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Methods

toHeaders :: GetRestApis -> [Header]

ToPath GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Methods

toPath :: GetRestApis -> ByteString

ToQuery GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Methods

toQuery :: GetRestApis -> QueryString

AWSPager GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Methods

page :: GetRestApis -> AWSResponse GetRestApis -> Maybe GetRestApis

AWSRequest GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Associated Types

type AWSResponse GetRestApis

Methods

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

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

Generic GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Associated Types

type Rep GetRestApis :: Type -> Type

Methods

from :: GetRestApis -> Rep GetRestApis x

to :: Rep GetRestApis x -> GetRestApis

Read GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Methods

readsPrec :: Int -> ReadS GetRestApis

readList :: ReadS [GetRestApis]

readPrec :: ReadPrec GetRestApis

readListPrec :: ReadPrec [GetRestApis]

Show GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Methods

showsPrec :: Int -> GetRestApis -> ShowS

show :: GetRestApis -> String

showList :: [GetRestApis] -> ShowS

NFData GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Methods

rnf :: GetRestApis -> ()

Eq GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Methods

(==) :: GetRestApis -> GetRestApis -> Bool

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

Hashable GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

Methods

hashWithSalt :: Int -> GetRestApis -> Int

hash :: GetRestApis -> Int

type AWSResponse GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

type AWSResponse GetRestApis = GetRestApisResponse

type Rep GetRestApis

Defined in Amazonka.APIGateway.GetRestApis

type Rep GetRestApis = D1 ('MetaData "GetRestApis" "Amazonka.APIGateway.GetRestApis" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetRestApis'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetRestApis :: GetRestApis

Create a value of GetRestApis 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:

GetRestApis, getRestApis_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetRestApis, getRestApis_position - The current pagination position in the paged result set.

Request Lenses

getRestApis_limit :: Lens' GetRestApis (Maybe Int)

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getRestApis_position :: Lens' GetRestApis (Maybe Text)

The current pagination position in the paged result set.

Destructuring the Response

data GetRestApisResponse

Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.

See: newGetRestApisResponse smart constructor.

Constructors

GetRestApisResponse'

Fields

• items :: Maybe [RestApi]

  The current page of elements from this collection.

• position :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic GetRestApisResponse

Defined in Amazonka.APIGateway.GetRestApis

Associated Types

type Rep GetRestApisResponse :: Type -> Type

Methods

from :: GetRestApisResponse -> Rep GetRestApisResponse x

to :: Rep GetRestApisResponse x -> GetRestApisResponse

Read GetRestApisResponse

Defined in Amazonka.APIGateway.GetRestApis

Methods

readsPrec :: Int -> ReadS GetRestApisResponse

readList :: ReadS [GetRestApisResponse]

readPrec :: ReadPrec GetRestApisResponse

readListPrec :: ReadPrec [GetRestApisResponse]

Show GetRestApisResponse

Defined in Amazonka.APIGateway.GetRestApis

Methods

showsPrec :: Int -> GetRestApisResponse -> ShowS

show :: GetRestApisResponse -> String

showList :: [GetRestApisResponse] -> ShowS

NFData GetRestApisResponse

Defined in Amazonka.APIGateway.GetRestApis

Methods

rnf :: GetRestApisResponse -> ()

Eq GetRestApisResponse

Defined in Amazonka.APIGateway.GetRestApis

Methods

(==) :: GetRestApisResponse -> GetRestApisResponse -> Bool

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

type Rep GetRestApisResponse

Defined in Amazonka.APIGateway.GetRestApis

type Rep GetRestApisResponse = D1 ('MetaData "GetRestApisResponse" "Amazonka.APIGateway.GetRestApis" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetRestApisResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RestApi])) :*: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRestApisResponse

Arguments

:: Int

$sel:httpStatus:GetRestApisResponse'

-> GetRestApisResponse

Create a value of GetRestApisResponse 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:

GetRestApisResponse, getRestApisResponse_items - The current page of elements from this collection.

GetRestApis, getRestApisResponse_position - Undocumented member.

$sel:httpStatus:GetRestApisResponse', getRestApisResponse_httpStatus - The response's http status code.

Response Lenses

getRestApisResponse_items :: Lens' GetRestApisResponse (Maybe [RestApi])

The current page of elements from this collection.

getRestApisResponse_position :: Lens' GetRestApisResponse (Maybe Text)

Undocumented member.

getRestApisResponse_httpStatus :: Lens' GetRestApisResponse Int

The response's http status code.