Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpsWorks.DescribeCommands

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the results of specified commands.

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 DescribeCommands Source #

See: newDescribeCommands smart constructor.

Constructors

DescribeCommands'

Fields

commandIds :: Maybe [Text]
An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.
deploymentId :: Maybe Text
The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.
instanceId :: Maybe Text
The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

Instances

Instances details

ToJSON DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods toJSON :: DescribeCommands -> Value # toEncoding :: DescribeCommands -> Encoding # toJSONList :: [DescribeCommands] -> Value # toEncodingList :: [DescribeCommands] -> Encoding #
ToHeaders DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods toHeaders :: DescribeCommands -> [Header] #
ToPath DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods toPath :: DescribeCommands -> ByteString #
ToQuery DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods toQuery :: DescribeCommands -> QueryString #
AWSRequest DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Associated Types type AWSResponse DescribeCommands # Methods request :: (Service -> Service) -> DescribeCommands -> Request DescribeCommands # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCommands -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCommands))) #
Generic DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Associated Types type Rep DescribeCommands :: Type -> Type # Methods from :: DescribeCommands -> Rep DescribeCommands x # to :: Rep DescribeCommands x -> DescribeCommands #
Read DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods readsPrec :: Int -> ReadS DescribeCommands # readList :: ReadS [DescribeCommands] # readPrec :: ReadPrec DescribeCommands # readListPrec :: ReadPrec [DescribeCommands] #
Show DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods showsPrec :: Int -> DescribeCommands -> ShowS # show :: DescribeCommands -> String # showList :: [DescribeCommands] -> ShowS #
NFData DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods rnf :: DescribeCommands -> () #
Eq DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods (==) :: DescribeCommands -> DescribeCommands -> Bool # (/=) :: DescribeCommands -> DescribeCommands -> Bool #
Hashable DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods hashWithSalt :: Int -> DescribeCommands -> Int # hash :: DescribeCommands -> Int #
type AWSResponse DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands type AWSResponse DescribeCommands = DescribeCommandsResponse
type Rep DescribeCommands Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands type Rep DescribeCommands = D1 ('MetaData "DescribeCommands" "Amazonka.OpsWorks.DescribeCommands" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeCommands'" 'PrefixI 'True) (S1 ('MetaSel ('Just "commandIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeCommands :: DescribeCommands Source #

Create a value of DescribeCommands 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:commandIds:DescribeCommands', describeCommands_commandIds - An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

DescribeCommands, describeCommands_deploymentId - The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.

DescribeCommands, describeCommands_instanceId - The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

Request Lenses

describeCommands_commandIds :: Lens' DescribeCommands (Maybe [Text]) Source #

An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

describeCommands_deploymentId :: Lens' DescribeCommands (Maybe Text) Source #

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

describeCommands_instanceId :: Lens' DescribeCommands (Maybe Text) Source #

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

Destructuring the Response

data DescribeCommandsResponse Source #

Contains the response to a DescribeCommands request.

See: newDescribeCommandsResponse smart constructor.

Constructors

DescribeCommandsResponse'
Fields commands :: Maybe [Command] An array of `Command` objects that describe each of the specified commands. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeCommandsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Associated Types type Rep DescribeCommandsResponse :: Type -> Type # Methods from :: DescribeCommandsResponse -> Rep DescribeCommandsResponse x # to :: Rep DescribeCommandsResponse x -> DescribeCommandsResponse #
Read DescribeCommandsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods readsPrec :: Int -> ReadS DescribeCommandsResponse # readList :: ReadS [DescribeCommandsResponse] # readPrec :: ReadPrec DescribeCommandsResponse # readListPrec :: ReadPrec [DescribeCommandsResponse] #
Show DescribeCommandsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods showsPrec :: Int -> DescribeCommandsResponse -> ShowS # show :: DescribeCommandsResponse -> String # showList :: [DescribeCommandsResponse] -> ShowS #
NFData DescribeCommandsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods rnf :: DescribeCommandsResponse -> () #
Eq DescribeCommandsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands Methods (==) :: DescribeCommandsResponse -> DescribeCommandsResponse -> Bool # (/=) :: DescribeCommandsResponse -> DescribeCommandsResponse -> Bool #
type Rep DescribeCommandsResponse Source #
Instance details Defined in Amazonka.OpsWorks.DescribeCommands type Rep DescribeCommandsResponse = D1 ('MetaData "DescribeCommandsResponse" "Amazonka.OpsWorks.DescribeCommands" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DescribeCommandsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "commands") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Command])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeCommandsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeCommandsResponse'`
-> DescribeCommandsResponse

Create a value of DescribeCommandsResponse 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:commands:DescribeCommandsResponse', describeCommandsResponse_commands - An array of Command objects that describe each of the specified commands.

$sel:httpStatus:DescribeCommandsResponse', describeCommandsResponse_httpStatus - The response's http status code.

Response Lenses

describeCommandsResponse_commands :: Lens' DescribeCommandsResponse (Maybe [Command]) Source #

An array of Command objects that describe each of the specified commands.

describeCommandsResponse_httpStatus :: Lens' DescribeCommandsResponse Int Source #

The response's http status code.