libZSservicesZSamazonka-opsworksZSamazonka-opsworks
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.OpsWorks.DescribeDeployments

Description

Requests a description of a specified set of deployments.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Synopsis

Creating a Request

data DescribeDeployments Source #

See: newDescribeDeployments smart constructor.

Constructors

DescribeDeployments' 

Fields

  • appId :: Maybe Text

    The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.

  • deploymentIds :: Maybe [Text]

    An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

  • stackId :: Maybe Text

    The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.

Instances

Instances details
Eq DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

(==) :: DescribeDeployments -> DescribeDeployments -> Bool #

(/=) :: DescribeDeployments -> DescribeDeployments -> Bool #

Read DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

readsPrec :: Int -> ReadS DescribeDeployments #

readList :: ReadS [DescribeDeployments] #

readPrec :: ReadPrec DescribeDeployments #

readListPrec :: ReadPrec [DescribeDeployments] #

Show DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

showsPrec :: Int -> DescribeDeployments -> ShowS #

show :: DescribeDeployments -> String #

showList :: [DescribeDeployments] -> ShowS #

Generic DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Associated Types

type Rep DescribeDeployments :: Type -> Type #

Methods

from :: DescribeDeployments -> Rep DescribeDeployments x #

to :: Rep DescribeDeployments x -> DescribeDeployments #

NFData DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

rnf :: DescribeDeployments -> () #

Hashable DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

hashWithSalt :: Int -> DescribeDeployments -> Int #

hash :: DescribeDeployments -> Int #

ToJSON DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

toJSON :: DescribeDeployments -> Value #

toEncoding :: DescribeDeployments -> Encoding #

toJSONList :: [DescribeDeployments] -> Value #

toEncodingList :: [DescribeDeployments] -> Encoding #

AWSRequest DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Associated Types

type AWSResponse DescribeDeployments #

Methods

request :: DescribeDeployments -> Request DescribeDeployments #

response :: MonadResource m => Logger -> Service -> Proxy DescribeDeployments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDeployments))) #

ToHeaders DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

toHeaders :: DescribeDeployments -> [Header] #

ToPath DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

toPath :: DescribeDeployments -> ByteString #

ToQuery DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

toQuery :: DescribeDeployments -> QueryString #

type Rep DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

type Rep DescribeDeployments = D1 ('MetaData "DescribeDeployments" "Amazonka.OpsWorks.DescribeDeployments" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "DescribeDeployments'" 'PrefixI 'True) (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deploymentIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DescribeDeployments Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

type AWSResponse DescribeDeployments = DescribeDeploymentsResponse

newDescribeDeployments :: DescribeDeployments Source #

Create a value of DescribeDeployments 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:appId:DescribeDeployments', describeDeployments_appId - The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.

$sel:deploymentIds:DescribeDeployments', describeDeployments_deploymentIds - An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

$sel:stackId:DescribeDeployments', describeDeployments_stackId - The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.

Request Lenses

describeDeployments_appId :: Lens' DescribeDeployments (Maybe Text) Source #

The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.

describeDeployments_deploymentIds :: Lens' DescribeDeployments (Maybe [Text]) Source #

An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

describeDeployments_stackId :: Lens' DescribeDeployments (Maybe Text) Source #

The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.

Destructuring the Response

data DescribeDeploymentsResponse Source #

Contains the response to a DescribeDeployments request.

See: newDescribeDeploymentsResponse smart constructor.

Constructors

DescribeDeploymentsResponse' 

Fields

Instances

Instances details
Eq DescribeDeploymentsResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

(==) :: DescribeDeploymentsResponse -> DescribeDeploymentsResponse -> Bool #

(/=) :: DescribeDeploymentsResponse -> DescribeDeploymentsResponse -> Bool #

Read DescribeDeploymentsResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

readsPrec :: Int -> ReadS DescribeDeploymentsResponse #

readList :: ReadS [DescribeDeploymentsResponse] #

readPrec :: ReadPrec DescribeDeploymentsResponse #

readListPrec :: ReadPrec [DescribeDeploymentsResponse] #

Show DescribeDeploymentsResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

showsPrec :: Int -> DescribeDeploymentsResponse -> ShowS #

show :: DescribeDeploymentsResponse -> String #

showList :: [DescribeDeploymentsResponse] -> ShowS #

Generic DescribeDeploymentsResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Associated Types

type Rep DescribeDeploymentsResponse :: Type -> Type #

Methods

from :: DescribeDeploymentsResponse -> Rep DescribeDeploymentsResponse x #

to :: Rep DescribeDeploymentsResponse x -> DescribeDeploymentsResponse #

NFData DescribeDeploymentsResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

Methods

rnf :: DescribeDeploymentsResponse -> () #

type Rep DescribeDeploymentsResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.DescribeDeployments

type Rep DescribeDeploymentsResponse = D1 ('MetaData "DescribeDeploymentsResponse" "Amazonka.OpsWorks.DescribeDeployments" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "DescribeDeploymentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deployments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Deployment])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeDeploymentsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeDeploymentsResponse'

-> DescribeDeploymentsResponse 

Create a value of DescribeDeploymentsResponse 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:deployments:DescribeDeploymentsResponse', describeDeploymentsResponse_deployments - An array of Deployment objects that describe the deployments.

$sel:httpStatus:DescribeDeploymentsResponse', describeDeploymentsResponse_httpStatus - The response's http status code.

Response Lenses

describeDeploymentsResponse_deployments :: Lens' DescribeDeploymentsResponse (Maybe [Deployment]) Source #

An array of Deployment objects that describe the deployments.

describeDeploymentsResponse_httpStatus :: Lens' DescribeDeploymentsResponse Int Source #

The response's http status code.