Amazonka.APIGateway.GetDeployments

Gets information about a Deployments collection.

This operation returns paginated results.

Creating a Request

data GetDeployments

Requests API Gateway to get information about a Deployments collection.

See: newGetDeployments smart constructor.

Constructors

GetDeployments'

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.

• restApiId :: Text

  The string identifier of the associated RestApi.

Instances

ToHeaders GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Methods

toHeaders :: GetDeployments -> [Header]

ToPath GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Methods

toPath :: GetDeployments -> ByteString

ToQuery GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Methods

toQuery :: GetDeployments -> QueryString

AWSPager GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Methods

page :: GetDeployments -> AWSResponse GetDeployments -> Maybe GetDeployments

AWSRequest GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Associated Types

type AWSResponse GetDeployments

Methods

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

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

Generic GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Associated Types

type Rep GetDeployments :: Type -> Type

Methods

from :: GetDeployments -> Rep GetDeployments x

to :: Rep GetDeployments x -> GetDeployments

Read GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Methods

readsPrec :: Int -> ReadS GetDeployments

readList :: ReadS [GetDeployments]

readPrec :: ReadPrec GetDeployments

readListPrec :: ReadPrec [GetDeployments]

Show GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Methods

showsPrec :: Int -> GetDeployments -> ShowS

show :: GetDeployments -> String

showList :: [GetDeployments] -> ShowS

NFData GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Methods

rnf :: GetDeployments -> ()

Eq GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Methods

(==) :: GetDeployments -> GetDeployments -> Bool

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

Hashable GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

Methods

hashWithSalt :: Int -> GetDeployments -> Int

hash :: GetDeployments -> Int

type AWSResponse GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

type AWSResponse GetDeployments = GetDeploymentsResponse

type Rep GetDeployments

Defined in Amazonka.APIGateway.GetDeployments

type Rep GetDeployments = D1 ('MetaData "GetDeployments" "Amazonka.APIGateway.GetDeployments" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDeployments'" 'PrefixI 'True) (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))))

newGetDeployments

Arguments

:: Text

GetDeployments

-> GetDeployments

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

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

GetDeployments, getDeployments_position - The current pagination position in the paged result set.

GetDeployments, getDeployments_restApiId - The string identifier of the associated RestApi.

Request Lenses

getDeployments_limit :: Lens' GetDeployments (Maybe Int)

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

getDeployments_position :: Lens' GetDeployments (Maybe Text)

The current pagination position in the paged result set.

getDeployments_restApiId :: Lens' GetDeployments Text

The string identifier of the associated RestApi.

Destructuring the Response

data GetDeploymentsResponse

Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.

See: newGetDeploymentsResponse smart constructor.

Constructors

GetDeploymentsResponse'

Fields

• items :: Maybe [Deployment]

  The current page of elements from this collection.

• position :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic GetDeploymentsResponse

Defined in Amazonka.APIGateway.GetDeployments

Associated Types

type Rep GetDeploymentsResponse :: Type -> Type

Methods

from :: GetDeploymentsResponse -> Rep GetDeploymentsResponse x

to :: Rep GetDeploymentsResponse x -> GetDeploymentsResponse

Read GetDeploymentsResponse

Defined in Amazonka.APIGateway.GetDeployments

Methods

readsPrec :: Int -> ReadS GetDeploymentsResponse

readList :: ReadS [GetDeploymentsResponse]

readPrec :: ReadPrec GetDeploymentsResponse

readListPrec :: ReadPrec [GetDeploymentsResponse]

Show GetDeploymentsResponse

Defined in Amazonka.APIGateway.GetDeployments

Methods

showsPrec :: Int -> GetDeploymentsResponse -> ShowS

show :: GetDeploymentsResponse -> String

showList :: [GetDeploymentsResponse] -> ShowS

NFData GetDeploymentsResponse

Defined in Amazonka.APIGateway.GetDeployments

Methods

rnf :: GetDeploymentsResponse -> ()

Eq GetDeploymentsResponse

Defined in Amazonka.APIGateway.GetDeployments

Methods

(==) :: GetDeploymentsResponse -> GetDeploymentsResponse -> Bool

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

type Rep GetDeploymentsResponse

Defined in Amazonka.APIGateway.GetDeployments

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

newGetDeploymentsResponse

Arguments

:: Int

$sel:httpStatus:GetDeploymentsResponse'

-> GetDeploymentsResponse

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

GetDeploymentsResponse, getDeploymentsResponse_items - The current page of elements from this collection.

GetDeployments, getDeploymentsResponse_position - Undocumented member.

$sel:httpStatus:GetDeploymentsResponse', getDeploymentsResponse_httpStatus - The response's http status code.

Response Lenses

getDeploymentsResponse_items :: Lens' GetDeploymentsResponse (Maybe [Deployment])

The current page of elements from this collection.

getDeploymentsResponse_position :: Lens' GetDeploymentsResponse (Maybe Text)

Undocumented member.

getDeploymentsResponse_httpStatus :: Lens' GetDeploymentsResponse Int

The response's http status code.