Amazonka.OpsWorks.DescribeApps

Requests a description of a specified set of apps.

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.

Creating a Request

data DescribeApps

See: newDescribeApps smart constructor.

Constructors

DescribeApps'

Fields

• appIds :: Maybe [Text]

  An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

• stackId :: Maybe Text

  The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

Instances

ToJSON DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Methods

toJSON :: DescribeApps -> Value

toEncoding :: DescribeApps -> Encoding

toJSONList :: [DescribeApps] -> Value

toEncodingList :: [DescribeApps] -> Encoding

ToHeaders DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Methods

toHeaders :: DescribeApps -> [Header]

ToPath DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Methods

toPath :: DescribeApps -> ByteString

ToQuery DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Methods

toQuery :: DescribeApps -> QueryString

AWSRequest DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Associated Types

type AWSResponse DescribeApps

Methods

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

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

Generic DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Associated Types

type Rep DescribeApps :: Type -> Type

Methods

from :: DescribeApps -> Rep DescribeApps x

to :: Rep DescribeApps x -> DescribeApps

Read DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Methods

readsPrec :: Int -> ReadS DescribeApps

readList :: ReadS [DescribeApps]

readPrec :: ReadPrec DescribeApps

readListPrec :: ReadPrec [DescribeApps]

Show DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Methods

showsPrec :: Int -> DescribeApps -> ShowS

show :: DescribeApps -> String

showList :: [DescribeApps] -> ShowS

NFData DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Methods

rnf :: DescribeApps -> ()

Eq DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Methods

(==) :: DescribeApps -> DescribeApps -> Bool

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

Hashable DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

Methods

hashWithSalt :: Int -> DescribeApps -> Int

hash :: DescribeApps -> Int

type AWSResponse DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

type AWSResponse DescribeApps = DescribeAppsResponse

type Rep DescribeApps

Defined in Amazonka.OpsWorks.DescribeApps

type Rep DescribeApps = D1 ('MetaData "DescribeApps" "Amazonka.OpsWorks.DescribeApps" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeApps'" 'PrefixI 'True) (S1 ('MetaSel ('Just "appIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDescribeApps :: DescribeApps

Create a value of DescribeApps 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:appIds:DescribeApps', describeApps_appIds - An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

DescribeApps, describeApps_stackId - The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

Request Lenses

describeApps_appIds :: Lens' DescribeApps (Maybe [Text])

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

describeApps_stackId :: Lens' DescribeApps (Maybe Text)

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

Destructuring the Response

data DescribeAppsResponse

Contains the response to a DescribeApps request.

See: newDescribeAppsResponse smart constructor.

Constructors

DescribeAppsResponse'

Fields

• apps :: Maybe [App]

  An array of App objects that describe the specified apps.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeAppsResponse

Defined in Amazonka.OpsWorks.DescribeApps

Associated Types

type Rep DescribeAppsResponse :: Type -> Type

Methods

from :: DescribeAppsResponse -> Rep DescribeAppsResponse x

to :: Rep DescribeAppsResponse x -> DescribeAppsResponse

Read DescribeAppsResponse

Defined in Amazonka.OpsWorks.DescribeApps

Methods

readsPrec :: Int -> ReadS DescribeAppsResponse

readList :: ReadS [DescribeAppsResponse]

readPrec :: ReadPrec DescribeAppsResponse

readListPrec :: ReadPrec [DescribeAppsResponse]

Show DescribeAppsResponse

Defined in Amazonka.OpsWorks.DescribeApps

Methods

showsPrec :: Int -> DescribeAppsResponse -> ShowS

show :: DescribeAppsResponse -> String

showList :: [DescribeAppsResponse] -> ShowS

NFData DescribeAppsResponse

Defined in Amazonka.OpsWorks.DescribeApps

Methods

rnf :: DescribeAppsResponse -> ()

Eq DescribeAppsResponse

Defined in Amazonka.OpsWorks.DescribeApps

Methods

(==) :: DescribeAppsResponse -> DescribeAppsResponse -> Bool

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

type Rep DescribeAppsResponse

Defined in Amazonka.OpsWorks.DescribeApps

type Rep DescribeAppsResponse = D1 ('MetaData "DescribeAppsResponse" "Amazonka.OpsWorks.DescribeApps" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeAppsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [App])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeAppsResponse

Arguments

:: Int

$sel:httpStatus:DescribeAppsResponse'

-> DescribeAppsResponse

Create a value of DescribeAppsResponse 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:apps:DescribeAppsResponse', describeAppsResponse_apps - An array of App objects that describe the specified apps.

$sel:httpStatus:DescribeAppsResponse', describeAppsResponse_httpStatus - The response's http status code.

Response Lenses

describeAppsResponse_apps :: Lens' DescribeAppsResponse (Maybe [App])

An array of App objects that describe the specified apps.

describeAppsResponse_httpStatus :: Lens' DescribeAppsResponse Int

The response's http status code.