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.EMR.ListInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.

This operation returns paginated results.

Synopsis

data ListInstances = ListInstances' {
- instanceFleetId :: Maybe Text
- instanceFleetType :: Maybe InstanceFleetType
- instanceGroupId :: Maybe Text
- instanceGroupTypes :: Maybe [InstanceGroupType]
- instanceStates :: Maybe [InstanceState]
- marker :: Maybe Text
- clusterId :: Text
}
newListInstances :: Text -> ListInstances
listInstances_instanceFleetId :: Lens' ListInstances (Maybe Text)
listInstances_instanceFleetType :: Lens' ListInstances (Maybe InstanceFleetType)
listInstances_instanceGroupId :: Lens' ListInstances (Maybe Text)
listInstances_instanceGroupTypes :: Lens' ListInstances (Maybe [InstanceGroupType])
listInstances_instanceStates :: Lens' ListInstances (Maybe [InstanceState])
listInstances_marker :: Lens' ListInstances (Maybe Text)
listInstances_clusterId :: Lens' ListInstances Text
data ListInstancesResponse = ListInstancesResponse' {
- instances :: Maybe [Instance]
- marker :: Maybe Text
- httpStatus :: Int
}
newListInstancesResponse :: Int -> ListInstancesResponse
listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [Instance])
listInstancesResponse_marker :: Lens' ListInstancesResponse (Maybe Text)
listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int

Creating a Request

data ListInstances Source #

This input determines which instances to list.

See: newListInstances smart constructor.

Constructors

ListInstances'

Fields

instanceFleetId :: Maybe Text
The unique identifier of the instance fleet.
instanceFleetType :: Maybe InstanceFleetType
The node type of the instance fleet. For example MASTER, CORE, or TASK.
instanceGroupId :: Maybe Text
The identifier of the instance group for which to list the instances.
instanceGroupTypes :: Maybe [InstanceGroupType]
The type of instance group for which to list the instances.
instanceStates :: Maybe [InstanceState]
A list of instance states that will filter the instances returned with this request.
marker :: Maybe Text
The pagination token that indicates the next set of results to retrieve.
clusterId :: Text
The identifier of the cluster for which to list the instances.

Instances

Instances details

ToJSON ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods toJSON :: ListInstances -> Value # toEncoding :: ListInstances -> Encoding # toJSONList :: [ListInstances] -> Value # toEncodingList :: [ListInstances] -> Encoding #
ToHeaders ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods toHeaders :: ListInstances -> [Header] #
ToPath ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods toPath :: ListInstances -> ByteString #
ToQuery ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods toQuery :: ListInstances -> QueryString #
AWSPager ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods page :: ListInstances -> AWSResponse ListInstances -> Maybe ListInstances #
AWSRequest ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Associated Types type AWSResponse ListInstances # Methods request :: (Service -> Service) -> ListInstances -> Request ListInstances # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListInstances))) #
Generic ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Associated Types type Rep ListInstances :: Type -> Type # Methods from :: ListInstances -> Rep ListInstances x # to :: Rep ListInstances x -> ListInstances #
Read ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods readsPrec :: Int -> ReadS ListInstances # readList :: ReadS [ListInstances] # readPrec :: ReadPrec ListInstances # readListPrec :: ReadPrec [ListInstances] #
Show ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods showsPrec :: Int -> ListInstances -> ShowS # show :: ListInstances -> String # showList :: [ListInstances] -> ShowS #
NFData ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods rnf :: ListInstances -> () #
Eq ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods (==) :: ListInstances -> ListInstances -> Bool # (/=) :: ListInstances -> ListInstances -> Bool #
Hashable ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods hashWithSalt :: Int -> ListInstances -> Int # hash :: ListInstances -> Int #
type AWSResponse ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances type AWSResponse ListInstances = ListInstancesResponse
type Rep ListInstances Source #
Instance details Defined in Amazonka.EMR.ListInstances type Rep ListInstances = D1 ('MetaData "ListInstances" "Amazonka.EMR.ListInstances" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "ListInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceFleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "instanceFleetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceFleetType)) :: S1 ('MetaSel ('Just "instanceGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "instanceGroupTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceGroupType])) :: S1 ('MetaSel ('Just "instanceStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceState]))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListInstances Source #

Arguments

:: Text	`$sel:clusterId:ListInstances'`
-> ListInstances

Create a value of ListInstances 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:

ListInstances, listInstances_instanceFleetId - The unique identifier of the instance fleet.

ListInstances, listInstances_instanceFleetType - The node type of the instance fleet. For example MASTER, CORE, or TASK.

ListInstances, listInstances_instanceGroupId - The identifier of the instance group for which to list the instances.

$sel:instanceGroupTypes:ListInstances', listInstances_instanceGroupTypes - The type of instance group for which to list the instances.

$sel:instanceStates:ListInstances', listInstances_instanceStates - A list of instance states that will filter the instances returned with this request.

ListInstances, listInstances_marker - The pagination token that indicates the next set of results to retrieve.

$sel:clusterId:ListInstances', listInstances_clusterId - The identifier of the cluster for which to list the instances.

Request Lenses

listInstances_instanceFleetId :: Lens' ListInstances (Maybe Text) Source #

The unique identifier of the instance fleet.

listInstances_instanceFleetType :: Lens' ListInstances (Maybe InstanceFleetType) Source #

The node type of the instance fleet. For example MASTER, CORE, or TASK.

listInstances_instanceGroupId :: Lens' ListInstances (Maybe Text) Source #

The identifier of the instance group for which to list the instances.

listInstances_instanceGroupTypes :: Lens' ListInstances (Maybe [InstanceGroupType]) Source #

The type of instance group for which to list the instances.

listInstances_instanceStates :: Lens' ListInstances (Maybe [InstanceState]) Source #

A list of instance states that will filter the instances returned with this request.

listInstances_marker :: Lens' ListInstances (Maybe Text) Source #

The pagination token that indicates the next set of results to retrieve.

listInstances_clusterId :: Lens' ListInstances Text Source #

The identifier of the cluster for which to list the instances.

Destructuring the Response

data ListInstancesResponse Source #

This output contains the list of instances.

See: newListInstancesResponse smart constructor.

Constructors

ListInstancesResponse'
Fields instances :: Maybe [Instance] The list of instances for the cluster and given filters. marker :: Maybe Text The pagination token that indicates the next set of results to retrieve. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListInstancesResponse Source #
Instance details Defined in Amazonka.EMR.ListInstances Associated Types type Rep ListInstancesResponse :: Type -> Type # Methods from :: ListInstancesResponse -> Rep ListInstancesResponse x # to :: Rep ListInstancesResponse x -> ListInstancesResponse #
Read ListInstancesResponse Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods readsPrec :: Int -> ReadS ListInstancesResponse # readList :: ReadS [ListInstancesResponse] # readPrec :: ReadPrec ListInstancesResponse # readListPrec :: ReadPrec [ListInstancesResponse] #
Show ListInstancesResponse Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods showsPrec :: Int -> ListInstancesResponse -> ShowS # show :: ListInstancesResponse -> String # showList :: [ListInstancesResponse] -> ShowS #
NFData ListInstancesResponse Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods rnf :: ListInstancesResponse -> () #
Eq ListInstancesResponse Source #
Instance details Defined in Amazonka.EMR.ListInstances Methods (==) :: ListInstancesResponse -> ListInstancesResponse -> Bool # (/=) :: ListInstancesResponse -> ListInstancesResponse -> Bool #
type Rep ListInstancesResponse Source #
Instance details Defined in Amazonka.EMR.ListInstances type Rep ListInstancesResponse = D1 ('MetaData "ListInstancesResponse" "Amazonka.EMR.ListInstances" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "ListInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Instance])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListInstancesResponse Source #

Arguments

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

Create a value of ListInstancesResponse 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:instances:ListInstancesResponse', listInstancesResponse_instances - The list of instances for the cluster and given filters.

ListInstances, listInstancesResponse_marker - The pagination token that indicates the next set of results to retrieve.

$sel:httpStatus:ListInstancesResponse', listInstancesResponse_httpStatus - The response's http status code.

Response Lenses

listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [Instance]) Source #

The list of instances for the cluster and given filters.

listInstancesResponse_marker :: Lens' ListInstancesResponse (Maybe Text) Source #

The pagination token that indicates the next set of results to retrieve.

listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int Source #

The response's http status code.