Amazonka.APIGateway.GetDeployment

Gets information about a Deployment resource.

Creating a Request

data GetDeployment

Requests API Gateway to get information about a Deployment resource.

See: newGetDeployment smart constructor.

Constructors

GetDeployment'

Fields

• embed :: Maybe [Text]

  A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

• restApiId :: Text

  The string identifier of the associated RestApi.

• deploymentId :: Text

  The identifier of the Deployment resource to get information about.

Instances

ToHeaders GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Methods

toHeaders :: GetDeployment -> [Header]

ToPath GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Methods

toPath :: GetDeployment -> ByteString

ToQuery GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Methods

toQuery :: GetDeployment -> QueryString

AWSRequest GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Associated Types

type AWSResponse GetDeployment

Methods

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

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

Generic GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Associated Types

type Rep GetDeployment :: Type -> Type

Methods

from :: GetDeployment -> Rep GetDeployment x

to :: Rep GetDeployment x -> GetDeployment

Read GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Methods

readsPrec :: Int -> ReadS GetDeployment

readList :: ReadS [GetDeployment]

readPrec :: ReadPrec GetDeployment

readListPrec :: ReadPrec [GetDeployment]

Show GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Methods

showsPrec :: Int -> GetDeployment -> ShowS

show :: GetDeployment -> String

showList :: [GetDeployment] -> ShowS

NFData GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Methods

rnf :: GetDeployment -> ()

Eq GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Methods

(==) :: GetDeployment -> GetDeployment -> Bool

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

Hashable GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

Methods

hashWithSalt :: Int -> GetDeployment -> Int

hash :: GetDeployment -> Int

type AWSResponse GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

type AWSResponse GetDeployment = Deployment

type Rep GetDeployment

Defined in Amazonka.APIGateway.GetDeployment

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

newGetDeployment

Arguments

:: Text

GetDeployment

-> Text

GetDeployment

-> GetDeployment

Create a value of GetDeployment 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:GetDeployment', getDeployment_embed - A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

GetDeployment, getDeployment_restApiId - The string identifier of the associated RestApi.

GetDeployment, getDeployment_deploymentId - The identifier of the Deployment resource to get information about.

Request Lenses

getDeployment_embed :: Lens' GetDeployment (Maybe [Text])

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

getDeployment_restApiId :: Lens' GetDeployment Text

The string identifier of the associated RestApi.

getDeployment_deploymentId :: Lens' GetDeployment Text

The identifier of the Deployment resource to get information about.

Destructuring the Response

data Deployment

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

See: newDeployment smart constructor.

Constructors

Deployment'

Fields

• apiSummary :: Maybe (HashMap Text (HashMap Text MethodSnapshot))

  A summary of the RestApi at the date and time that the deployment resource was created.

• createdDate :: Maybe POSIX

  The date and time that the deployment resource was created.

• description :: Maybe Text

  The description for the deployment resource.

• id :: Maybe Text

  The identifier for the deployment resource.

Instances

FromJSON Deployment

Defined in Amazonka.APIGateway.Types.Deployment

Methods

parseJSON :: Value -> Parser Deployment

parseJSONList :: Value -> Parser [Deployment]

Generic Deployment

Defined in Amazonka.APIGateway.Types.Deployment

Associated Types

type Rep Deployment :: Type -> Type

Methods

from :: Deployment -> Rep Deployment x

to :: Rep Deployment x -> Deployment

Read Deployment

Defined in Amazonka.APIGateway.Types.Deployment

Methods

readsPrec :: Int -> ReadS Deployment

readList :: ReadS [Deployment]

readPrec :: ReadPrec Deployment

readListPrec :: ReadPrec [Deployment]

Show Deployment

Defined in Amazonka.APIGateway.Types.Deployment

Methods

showsPrec :: Int -> Deployment -> ShowS

show :: Deployment -> String

showList :: [Deployment] -> ShowS

NFData Deployment

Defined in Amazonka.APIGateway.Types.Deployment

Methods

rnf :: Deployment -> ()

Eq Deployment

Defined in Amazonka.APIGateway.Types.Deployment

Methods

(==) :: Deployment -> Deployment -> Bool

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

Hashable Deployment

Defined in Amazonka.APIGateway.Types.Deployment

Methods

hashWithSalt :: Int -> Deployment -> Int

hash :: Deployment -> Int

type Rep Deployment

Defined in Amazonka.APIGateway.Types.Deployment

type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.APIGateway.Types.Deployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text MethodSnapshot)))) :*: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDeployment :: Deployment

Create a value of Deployment 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:apiSummary:Deployment', deployment_apiSummary - A summary of the RestApi at the date and time that the deployment resource was created.

$sel:createdDate:Deployment', deployment_createdDate - The date and time that the deployment resource was created.

$sel:description:Deployment', deployment_description - The description for the deployment resource.

$sel:id:Deployment', deployment_id - The identifier for the deployment resource.

Response Lenses

deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot)))

A summary of the RestApi at the date and time that the deployment resource was created.

deployment_createdDate :: Lens' Deployment (Maybe UTCTime)

The date and time that the deployment resource was created.

deployment_description :: Lens' Deployment (Maybe Text)

The description for the deployment resource.

deployment_id :: Lens' Deployment (Maybe Text)

The identifier for the deployment resource.