Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeDeploy.ListOnPremisesInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of names for one or more on-premises instances.

Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

This operation returns paginated results.

Synopsis

Creating a Request

data ListOnPremisesInstances Source #

Represents the input of a ListOnPremisesInstances operation.

See: newListOnPremisesInstances smart constructor.

Constructors

ListOnPremisesInstances'

Fields

tagFilters :: Maybe [TagFilter]
The on-premises instance tags that are used to restrict the on-premises instance names returned.
nextToken :: Maybe Text
An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.
registrationStatus :: Maybe RegistrationStatus
The registration status of the on-premises instances:
- Deregistered: Include deregistered on-premises instances in the resulting list.
- Registered: Include registered on-premises instances in the resulting list.

Instances

Instances details

Eq ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods (==) :: ListOnPremisesInstances -> ListOnPremisesInstances -> Bool # (/=) :: ListOnPremisesInstances -> ListOnPremisesInstances -> Bool #
Read ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods readsPrec :: Int -> ReadS ListOnPremisesInstances # readList :: ReadS [ListOnPremisesInstances] # readPrec :: ReadPrec ListOnPremisesInstances # readListPrec :: ReadPrec [ListOnPremisesInstances] #
Show ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods showsPrec :: Int -> ListOnPremisesInstances -> ShowS # show :: ListOnPremisesInstances -> String # showList :: [ListOnPremisesInstances] -> ShowS #
Generic ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Associated Types type Rep ListOnPremisesInstances :: Type -> Type # Methods from :: ListOnPremisesInstances -> Rep ListOnPremisesInstances x # to :: Rep ListOnPremisesInstances x -> ListOnPremisesInstances #
NFData ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods rnf :: ListOnPremisesInstances -> () #
Hashable ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods hashWithSalt :: Int -> ListOnPremisesInstances -> Int # hash :: ListOnPremisesInstances -> Int #
ToJSON ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods toJSON :: ListOnPremisesInstances -> Value # toEncoding :: ListOnPremisesInstances -> Encoding # toJSONList :: [ListOnPremisesInstances] -> Value # toEncodingList :: [ListOnPremisesInstances] -> Encoding #
AWSPager ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods page :: ListOnPremisesInstances -> AWSResponse ListOnPremisesInstances -> Maybe ListOnPremisesInstances #
AWSRequest ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Associated Types type AWSResponse ListOnPremisesInstances # Methods request :: ListOnPremisesInstances -> Request ListOnPremisesInstances # response :: MonadResource m => Logger -> Service -> Proxy ListOnPremisesInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListOnPremisesInstances))) #
ToHeaders ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods toHeaders :: ListOnPremisesInstances -> [Header] #
ToPath ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods toPath :: ListOnPremisesInstances -> ByteString #
ToQuery ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods toQuery :: ListOnPremisesInstances -> QueryString #
type Rep ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances type Rep ListOnPremisesInstances = D1 ('MetaData "ListOnPremisesInstances" "Amazonka.CodeDeploy.ListOnPremisesInstances" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "ListOnPremisesInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tagFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagFilter])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "registrationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistrationStatus)))))
type AWSResponse ListOnPremisesInstances Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances type AWSResponse ListOnPremisesInstances = ListOnPremisesInstancesResponse

newListOnPremisesInstances :: ListOnPremisesInstances Source #

Create a value of ListOnPremisesInstances 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:tagFilters:ListOnPremisesInstances', listOnPremisesInstances_tagFilters - The on-premises instance tags that are used to restrict the on-premises instance names returned.

$sel:nextToken:ListOnPremisesInstances', listOnPremisesInstances_nextToken - An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.

$sel:registrationStatus:ListOnPremisesInstances', listOnPremisesInstances_registrationStatus - The registration status of the on-premises instances:

Deregistered: Include deregistered on-premises instances in the resulting list.
Registered: Include registered on-premises instances in the resulting list.

Request Lenses

listOnPremisesInstances_tagFilters :: Lens' ListOnPremisesInstances (Maybe [TagFilter]) Source #

The on-premises instance tags that are used to restrict the on-premises instance names returned.

listOnPremisesInstances_nextToken :: Lens' ListOnPremisesInstances (Maybe Text) Source #

An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.

listOnPremisesInstances_registrationStatus :: Lens' ListOnPremisesInstances (Maybe RegistrationStatus) Source #

The registration status of the on-premises instances:

Deregistered: Include deregistered on-premises instances in the resulting list.
Registered: Include registered on-premises instances in the resulting list.

Destructuring the Response

data ListOnPremisesInstancesResponse Source #

Represents the output of the list on-premises instances operation.

See: newListOnPremisesInstancesResponse smart constructor.

Constructors

ListOnPremisesInstancesResponse'
Fields nextToken :: Maybe Text If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list. instanceNames :: Maybe [Text] The list of matching on-premises instance names. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListOnPremisesInstancesResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods (==) :: ListOnPremisesInstancesResponse -> ListOnPremisesInstancesResponse -> Bool # (/=) :: ListOnPremisesInstancesResponse -> ListOnPremisesInstancesResponse -> Bool #
Read ListOnPremisesInstancesResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods readsPrec :: Int -> ReadS ListOnPremisesInstancesResponse # readList :: ReadS [ListOnPremisesInstancesResponse] # readPrec :: ReadPrec ListOnPremisesInstancesResponse # readListPrec :: ReadPrec [ListOnPremisesInstancesResponse] #
Show ListOnPremisesInstancesResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods showsPrec :: Int -> ListOnPremisesInstancesResponse -> ShowS # show :: ListOnPremisesInstancesResponse -> String # showList :: [ListOnPremisesInstancesResponse] -> ShowS #
Generic ListOnPremisesInstancesResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Associated Types type Rep ListOnPremisesInstancesResponse :: Type -> Type # Methods from :: ListOnPremisesInstancesResponse -> Rep ListOnPremisesInstancesResponse x # to :: Rep ListOnPremisesInstancesResponse x -> ListOnPremisesInstancesResponse #
NFData ListOnPremisesInstancesResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances Methods rnf :: ListOnPremisesInstancesResponse -> () #
type Rep ListOnPremisesInstancesResponse Source #
Instance details Defined in Amazonka.CodeDeploy.ListOnPremisesInstances type Rep ListOnPremisesInstancesResponse = D1 ('MetaData "ListOnPremisesInstancesResponse" "Amazonka.CodeDeploy.ListOnPremisesInstances" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "ListOnPremisesInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "instanceNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListOnPremisesInstancesResponse Source #

Arguments

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

Create a value of ListOnPremisesInstancesResponse 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:nextToken:ListOnPremisesInstances', listOnPremisesInstancesResponse_nextToken - If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.

$sel:instanceNames:ListOnPremisesInstancesResponse', listOnPremisesInstancesResponse_instanceNames - The list of matching on-premises instance names.

$sel:httpStatus:ListOnPremisesInstancesResponse', listOnPremisesInstancesResponse_httpStatus - The response's http status code.

Response Lenses

listOnPremisesInstancesResponse_nextToken :: Lens' ListOnPremisesInstancesResponse (Maybe Text) Source #

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.

listOnPremisesInstancesResponse_instanceNames :: Lens' ListOnPremisesInstancesResponse (Maybe [Text]) Source #

The list of matching on-premises instance names.

listOnPremisesInstancesResponse_httpStatus :: Lens' ListOnPremisesInstancesResponse Int Source #

The response's http status code.