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.EC2.DescribePlacementGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.

Synopsis

data DescribePlacementGroups = DescribePlacementGroups' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- groupIds :: Maybe [Text]
- groupNames :: Maybe [Text]
}
newDescribePlacementGroups :: DescribePlacementGroups
describePlacementGroups_dryRun :: Lens' DescribePlacementGroups (Maybe Bool)
describePlacementGroups_filters :: Lens' DescribePlacementGroups (Maybe [Filter])
describePlacementGroups_groupIds :: Lens' DescribePlacementGroups (Maybe [Text])
describePlacementGroups_groupNames :: Lens' DescribePlacementGroups (Maybe [Text])
data DescribePlacementGroupsResponse = DescribePlacementGroupsResponse' {
- placementGroups :: Maybe [PlacementGroup]
- httpStatus :: Int
}
newDescribePlacementGroupsResponse :: Int -> DescribePlacementGroupsResponse
describePlacementGroupsResponse_placementGroups :: Lens' DescribePlacementGroupsResponse (Maybe [PlacementGroup])
describePlacementGroupsResponse_httpStatus :: Lens' DescribePlacementGroupsResponse Int

Creating a Request

data DescribePlacementGroups Source #

See: newDescribePlacementGroups smart constructor.

Constructors

DescribePlacementGroups'

Fields

dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
filters :: Maybe [Filter]
The filters.
- group-name - The name of the placement group.
- group-arn - The Amazon Resource Name (ARN) of the placement group.
- spread-level - The spread level for the placement group (host | rack).
- state - The state of the placement group (pending | available | deleting | deleted).
- strategy - The strategy of the placement group (cluster | spread | partition).
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
groupIds :: Maybe [Text]
The IDs of the placement groups.
groupNames :: Maybe [Text]
The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.

Instances

Instances details

ToHeaders DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Methods toHeaders :: DescribePlacementGroups -> [Header] #
ToPath DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Methods toPath :: DescribePlacementGroups -> ByteString #
ToQuery DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Methods toQuery :: DescribePlacementGroups -> QueryString #
AWSRequest DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Associated Types type AWSResponse DescribePlacementGroups # Methods request :: (Service -> Service) -> DescribePlacementGroups -> Request DescribePlacementGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePlacementGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePlacementGroups))) #
Generic DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Associated Types type Rep DescribePlacementGroups :: Type -> Type # Methods from :: DescribePlacementGroups -> Rep DescribePlacementGroups x # to :: Rep DescribePlacementGroups x -> DescribePlacementGroups #
Read DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Methods readsPrec :: Int -> ReadS DescribePlacementGroups # readList :: ReadS [DescribePlacementGroups] # readPrec :: ReadPrec DescribePlacementGroups # readListPrec :: ReadPrec [DescribePlacementGroups] #
Show DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Methods showsPrec :: Int -> DescribePlacementGroups -> ShowS # show :: DescribePlacementGroups -> String # showList :: [DescribePlacementGroups] -> ShowS #
NFData DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Methods rnf :: DescribePlacementGroups -> () #
Eq DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Methods (==) :: DescribePlacementGroups -> DescribePlacementGroups -> Bool # (/=) :: DescribePlacementGroups -> DescribePlacementGroups -> Bool #
Hashable DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups Methods hashWithSalt :: Int -> DescribePlacementGroups -> Int # hash :: DescribePlacementGroups -> Int #
type AWSResponse DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups type AWSResponse DescribePlacementGroups = DescribePlacementGroupsResponse
type Rep DescribePlacementGroups Source #
Instance details Defined in Amazonka.EC2.DescribePlacementGroups type Rep DescribePlacementGroups = D1 ('MetaData "DescribePlacementGroups" "Amazonka.EC2.DescribePlacementGroups" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribePlacementGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "groupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "groupNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribePlacementGroups :: DescribePlacementGroups Source #

Create a value of DescribePlacementGroups 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:dryRun:DescribePlacementGroups', describePlacementGroups_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

$sel:filters:DescribePlacementGroups', describePlacementGroups_filters - The filters.

group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
spread-level - The spread level for the placement group (host | rack).
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

DescribePlacementGroups, describePlacementGroups_groupIds - The IDs of the placement groups.

DescribePlacementGroups, describePlacementGroups_groupNames - The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Request Lenses

describePlacementGroups_dryRun :: Lens' DescribePlacementGroups (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

describePlacementGroups_filters :: Lens' DescribePlacementGroups (Maybe [Filter]) Source #

The filters.

group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
spread-level - The spread level for the placement group (host | rack).
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

describePlacementGroups_groupIds :: Lens' DescribePlacementGroups (Maybe [Text]) Source #

The IDs of the placement groups.

describePlacementGroups_groupNames :: Lens' DescribePlacementGroups (Maybe [Text]) Source #

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Destructuring the Response

data DescribePlacementGroupsResponse Source #

See: newDescribePlacementGroupsResponse smart constructor.

Constructors

DescribePlacementGroupsResponse'
Fields placementGroups :: Maybe [PlacementGroup] Information about the placement groups. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribePlacementGroupsResponse Source #

Arguments

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

Create a value of DescribePlacementGroupsResponse 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:placementGroups:DescribePlacementGroupsResponse', describePlacementGroupsResponse_placementGroups - Information about the placement groups.

$sel:httpStatus:DescribePlacementGroupsResponse', describePlacementGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describePlacementGroupsResponse_placementGroups :: Lens' DescribePlacementGroupsResponse (Maybe [PlacementGroup]) Source #

Information about the placement groups.

describePlacementGroupsResponse_httpStatus :: Lens' DescribePlacementGroupsResponse Int Source #

The response's http status code.