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 |
Lists the attributes for Amazon ECS resources within a specified target
type and cluster. When you specify a target type and cluster,
ListAttributes
returns a list of attribute objects, one for each
attribute on each resource. You can filter the list of results to a
single attribute name to only return results that have that name. You
can also filter the results by attribute name and value. You can do
this, for example, to see which container instances in a cluster are
running a Linux AMI (ecs.os-type=linux
).
This operation returns paginated results.
Synopsis
- data ListAttributes = ListAttributes' {}
- newListAttributes :: TargetType -> ListAttributes
- listAttributes_attributeName :: Lens' ListAttributes (Maybe Text)
- listAttributes_attributeValue :: Lens' ListAttributes (Maybe Text)
- listAttributes_cluster :: Lens' ListAttributes (Maybe Text)
- listAttributes_maxResults :: Lens' ListAttributes (Maybe Int)
- listAttributes_nextToken :: Lens' ListAttributes (Maybe Text)
- listAttributes_targetType :: Lens' ListAttributes TargetType
- data ListAttributesResponse = ListAttributesResponse' {
- attributes :: Maybe [Attribute]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListAttributesResponse :: Int -> ListAttributesResponse
- listAttributesResponse_attributes :: Lens' ListAttributesResponse (Maybe [Attribute])
- listAttributesResponse_nextToken :: Lens' ListAttributesResponse (Maybe Text)
- listAttributesResponse_httpStatus :: Lens' ListAttributesResponse Int
Creating a Request
data ListAttributes Source #
See: newListAttributes
smart constructor.
ListAttributes' | |
|
Instances
Create a value of ListAttributes
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:attributeName:ListAttributes'
, listAttributes_attributeName
- The name of the attribute to filter the results with.
$sel:attributeValue:ListAttributes'
, listAttributes_attributeValue
- The value of the attribute to filter results with. You must also specify
an attribute name to use this parameter.
$sel:cluster:ListAttributes'
, listAttributes_cluster
- The short name or full Amazon Resource Name (ARN) of the cluster to list
attributes. If you do not specify a cluster, the default cluster is
assumed.
$sel:maxResults:ListAttributes'
, listAttributes_maxResults
- The maximum number of cluster results that ListAttributes
returned in
paginated output. When this parameter is used, ListAttributes
only
returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be
seen by sending another ListAttributes
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter isn't used, then ListAttributes
returns up to 100 results
and a nextToken
value if applicable.
ListAttributes
, listAttributes_nextToken
- The nextToken
value returned from a ListAttributes
request
indicating that more results are available to fulfill the request and
further calls are needed. If maxResults
was provided, it's possible
the number of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
ListAttributes
, listAttributes_targetType
- The type of the target to list attributes with.
Request Lenses
listAttributes_attributeName :: Lens' ListAttributes (Maybe Text) Source #
The name of the attribute to filter the results with.
listAttributes_attributeValue :: Lens' ListAttributes (Maybe Text) Source #
The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.
listAttributes_cluster :: Lens' ListAttributes (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
listAttributes_maxResults :: Lens' ListAttributes (Maybe Int) Source #
The maximum number of cluster results that ListAttributes
returned in
paginated output. When this parameter is used, ListAttributes
only
returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be
seen by sending another ListAttributes
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter isn't used, then ListAttributes
returns up to 100 results
and a nextToken
value if applicable.
listAttributes_nextToken :: Lens' ListAttributes (Maybe Text) Source #
The nextToken
value returned from a ListAttributes
request
indicating that more results are available to fulfill the request and
further calls are needed. If maxResults
was provided, it's possible
the number of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listAttributes_targetType :: Lens' ListAttributes TargetType Source #
The type of the target to list attributes with.
Destructuring the Response
data ListAttributesResponse Source #
See: newListAttributesResponse
smart constructor.
ListAttributesResponse' | |
|
Instances
newListAttributesResponse Source #
Create a value of ListAttributesResponse
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:
ListAttributesResponse
, listAttributesResponse_attributes
- A list of attribute objects that meet the criteria of the request.
ListAttributes
, listAttributesResponse_nextToken
- The nextToken
value to include in a future ListAttributes
request.
When the results of a ListAttributes
request exceed maxResults
, this
value can be used to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:ListAttributesResponse'
, listAttributesResponse_httpStatus
- The response's http status code.
Response Lenses
listAttributesResponse_attributes :: Lens' ListAttributesResponse (Maybe [Attribute]) Source #
A list of attribute objects that meet the criteria of the request.
listAttributesResponse_nextToken :: Lens' ListAttributesResponse (Maybe Text) Source #
The nextToken
value to include in a future ListAttributes
request.
When the results of a ListAttributes
request exceed maxResults
, this
value can be used to retrieve the next page of results. This value is
null
when there are no more results to return.
listAttributesResponse_httpStatus :: Lens' ListAttributesResponse Int Source #
The response's http status code.