Amazonka.APIGateway.GetResources

Lists information about a collection of Resource resources.

This operation returns paginated results.

Creating a Request

data GetResources

Request to list information about a collection of resources.

See: newGetResources smart constructor.

Constructors

GetResources'

Fields

• embed :: Maybe [Text]

  A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

• 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.

• restApiId :: Text

  The string identifier of the associated RestApi.

Instances

ToHeaders GetResources

Defined in Amazonka.APIGateway.GetResources

Methods

toHeaders :: GetResources -> [Header]

ToPath GetResources

Defined in Amazonka.APIGateway.GetResources

Methods

toPath :: GetResources -> ByteString

ToQuery GetResources

Defined in Amazonka.APIGateway.GetResources

Methods

toQuery :: GetResources -> QueryString

AWSPager GetResources

Defined in Amazonka.APIGateway.GetResources

Methods

page :: GetResources -> AWSResponse GetResources -> Maybe GetResources

AWSRequest GetResources

Defined in Amazonka.APIGateway.GetResources

Associated Types

type AWSResponse GetResources

Methods

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

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

Generic GetResources

Defined in Amazonka.APIGateway.GetResources

Associated Types

type Rep GetResources :: Type -> Type

Methods

from :: GetResources -> Rep GetResources x

to :: Rep GetResources x -> GetResources

Read GetResources

Defined in Amazonka.APIGateway.GetResources

Methods

readsPrec :: Int -> ReadS GetResources

readList :: ReadS [GetResources]

readPrec :: ReadPrec GetResources

readListPrec :: ReadPrec [GetResources]

Show GetResources

Defined in Amazonka.APIGateway.GetResources

Methods

showsPrec :: Int -> GetResources -> ShowS

show :: GetResources -> String

showList :: [GetResources] -> ShowS

NFData GetResources

Defined in Amazonka.APIGateway.GetResources

Methods

rnf :: GetResources -> ()

Eq GetResources

Defined in Amazonka.APIGateway.GetResources

Methods

(==) :: GetResources -> GetResources -> Bool

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

Hashable GetResources

Defined in Amazonka.APIGateway.GetResources

Methods

hashWithSalt :: Int -> GetResources -> Int

hash :: GetResources -> Int

type AWSResponse GetResources

Defined in Amazonka.APIGateway.GetResources

type AWSResponse GetResources = GetResourcesResponse

type Rep GetResources

Defined in Amazonka.APIGateway.GetResources

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

newGetResources

Arguments

:: Text

GetResources

-> GetResources

Create a value of GetResources 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:embed:GetResources', getResources_embed - A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

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

GetResources, getResources_position - The current pagination position in the paged result set.

GetResources, getResources_restApiId - The string identifier of the associated RestApi.

Request Lenses

getResources_embed :: Lens' GetResources (Maybe [Text])

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

getResources_limit :: Lens' GetResources (Maybe Int)

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

getResources_position :: Lens' GetResources (Maybe Text)

The current pagination position in the paged result set.

getResources_restApiId :: Lens' GetResources Text

The string identifier of the associated RestApi.

Destructuring the Response

data GetResourcesResponse

Represents a collection of Resource resources.

See: newGetResourcesResponse smart constructor.

Constructors

GetResourcesResponse'

Fields

• items :: Maybe [Resource]

  The current page of elements from this collection.

• position :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic GetResourcesResponse

Defined in Amazonka.APIGateway.GetResources

Associated Types

type Rep GetResourcesResponse :: Type -> Type

Methods

from :: GetResourcesResponse -> Rep GetResourcesResponse x

to :: Rep GetResourcesResponse x -> GetResourcesResponse

Read GetResourcesResponse

Defined in Amazonka.APIGateway.GetResources

Methods

readsPrec :: Int -> ReadS GetResourcesResponse

readList :: ReadS [GetResourcesResponse]

readPrec :: ReadPrec GetResourcesResponse

readListPrec :: ReadPrec [GetResourcesResponse]

Show GetResourcesResponse

Defined in Amazonka.APIGateway.GetResources

Methods

showsPrec :: Int -> GetResourcesResponse -> ShowS

show :: GetResourcesResponse -> String

showList :: [GetResourcesResponse] -> ShowS

NFData GetResourcesResponse

Defined in Amazonka.APIGateway.GetResources

Methods

rnf :: GetResourcesResponse -> ()

Eq GetResourcesResponse

Defined in Amazonka.APIGateway.GetResources

Methods

(==) :: GetResourcesResponse -> GetResourcesResponse -> Bool

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

type Rep GetResourcesResponse

Defined in Amazonka.APIGateway.GetResources

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

newGetResourcesResponse

Arguments

:: Int

$sel:httpStatus:GetResourcesResponse'

-> GetResourcesResponse

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

GetResourcesResponse, getResourcesResponse_items - The current page of elements from this collection.

GetResources, getResourcesResponse_position - Undocumented member.

$sel:httpStatus:GetResourcesResponse', getResourcesResponse_httpStatus - The response's http status code.

Response Lenses

getResourcesResponse_items :: Lens' GetResourcesResponse (Maybe [Resource])

The current page of elements from this collection.

getResourcesResponse_position :: Lens' GetResourcesResponse (Maybe Text)

Undocumented member.

getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int

The response's http status code.