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.GreengrassV2.ListDeployments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a paginated list of deployments.

This operation returns paginated results.

Synopsis

data ListDeployments = ListDeployments' {
- historyFilter :: Maybe DeploymentHistoryFilter
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- parentTargetArn :: Maybe Text
- targetArn :: Maybe Text
}
newListDeployments :: ListDeployments
listDeployments_historyFilter :: Lens' ListDeployments (Maybe DeploymentHistoryFilter)
listDeployments_maxResults :: Lens' ListDeployments (Maybe Natural)
listDeployments_nextToken :: Lens' ListDeployments (Maybe Text)
listDeployments_parentTargetArn :: Lens' ListDeployments (Maybe Text)
listDeployments_targetArn :: Lens' ListDeployments (Maybe Text)
data ListDeploymentsResponse = ListDeploymentsResponse' {
- deployments :: Maybe [Deployment]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListDeploymentsResponse :: Int -> ListDeploymentsResponse
listDeploymentsResponse_deployments :: Lens' ListDeploymentsResponse (Maybe [Deployment])
listDeploymentsResponse_nextToken :: Lens' ListDeploymentsResponse (Maybe Text)
listDeploymentsResponse_httpStatus :: Lens' ListDeploymentsResponse Int

Creating a Request

data ListDeployments Source #

See: newListDeployments smart constructor.

Constructors

ListDeployments'

Fields

historyFilter :: Maybe DeploymentHistoryFilter
The filter for the list of deployments. Choose one of the following options:
- ALL – The list includes all deployments.
- LATEST_ONLY – The list includes only the latest revision of each deployment.
Default: LATEST_ONLY
maxResults :: Maybe Natural
The maximum number of results to be returned per paginated request.
nextToken :: Maybe Text
The token to be used for the next set of paginated results.
parentTargetArn :: Maybe Text
The parent deployment's target ARN within a subdeployment.
targetArn :: Maybe Text
The ARN of the target IoT thing or thing group.

Instances

Instances details

ToHeaders ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Methods toHeaders :: ListDeployments -> [Header] #
ToPath ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Methods toPath :: ListDeployments -> ByteString #
ToQuery ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Methods toQuery :: ListDeployments -> QueryString #
AWSPager ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Methods page :: ListDeployments -> AWSResponse ListDeployments -> Maybe ListDeployments #
AWSRequest ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Associated Types type AWSResponse ListDeployments # Methods request :: (Service -> Service) -> ListDeployments -> Request ListDeployments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDeployments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDeployments))) #
Generic ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Associated Types type Rep ListDeployments :: Type -> Type # Methods from :: ListDeployments -> Rep ListDeployments x # to :: Rep ListDeployments x -> ListDeployments #
Read ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Methods readsPrec :: Int -> ReadS ListDeployments # readList :: ReadS [ListDeployments] # readPrec :: ReadPrec ListDeployments # readListPrec :: ReadPrec [ListDeployments] #
Show ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Methods showsPrec :: Int -> ListDeployments -> ShowS # show :: ListDeployments -> String # showList :: [ListDeployments] -> ShowS #
NFData ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Methods rnf :: ListDeployments -> () #
Eq ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Methods (==) :: ListDeployments -> ListDeployments -> Bool # (/=) :: ListDeployments -> ListDeployments -> Bool #
Hashable ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments Methods hashWithSalt :: Int -> ListDeployments -> Int # hash :: ListDeployments -> Int #
type AWSResponse ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments type AWSResponse ListDeployments = ListDeploymentsResponse
type Rep ListDeployments Source #
Instance details Defined in Amazonka.GreengrassV2.ListDeployments type Rep ListDeployments = D1 ('MetaData "ListDeployments" "Amazonka.GreengrassV2.ListDeployments" "amazonka-greengrassv2-2.0-CXiJQl197i43YI1Cz5IpiZ" 'False) (C1 ('MetaCons "ListDeployments'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "historyFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentHistoryFilter)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parentTargetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListDeployments :: ListDeployments Source #

Create a value of ListDeployments 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:historyFilter:ListDeployments', listDeployments_historyFilter - The filter for the list of deployments. Choose one of the following options:

ALL – The list includes all deployments.
LATEST_ONLY – The list includes only the latest revision of each deployment.

Default: LATEST_ONLY

$sel:maxResults:ListDeployments', listDeployments_maxResults - The maximum number of results to be returned per paginated request.

ListDeployments, listDeployments_nextToken - The token to be used for the next set of paginated results.

ListDeployments, listDeployments_parentTargetArn - The parent deployment's target ARN within a subdeployment.

ListDeployments, listDeployments_targetArn - The ARN of the target IoT thing or thing group.

Request Lenses

listDeployments_historyFilter :: Lens' ListDeployments (Maybe DeploymentHistoryFilter) Source #

The filter for the list of deployments. Choose one of the following options:

ALL – The list includes all deployments.
LATEST_ONLY – The list includes only the latest revision of each deployment.

Default: LATEST_ONLY

listDeployments_maxResults :: Lens' ListDeployments (Maybe Natural) Source #

The maximum number of results to be returned per paginated request.

listDeployments_nextToken :: Lens' ListDeployments (Maybe Text) Source #

The token to be used for the next set of paginated results.

listDeployments_parentTargetArn :: Lens' ListDeployments (Maybe Text) Source #

The parent deployment's target ARN within a subdeployment.

listDeployments_targetArn :: Lens' ListDeployments (Maybe Text) Source #

The ARN of the target IoT thing or thing group.

Destructuring the Response

data ListDeploymentsResponse Source #

See: newListDeploymentsResponse smart constructor.

Constructors

ListDeploymentsResponse'
Fields deployments :: Maybe [Deployment] A list that summarizes each deployment. nextToken :: Maybe Text The token for the next set of results, or null if there are no additional results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListDeploymentsResponse Source #

Arguments

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

Create a value of ListDeploymentsResponse 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:deployments:ListDeploymentsResponse', listDeploymentsResponse_deployments - A list that summarizes each deployment.

ListDeployments, listDeploymentsResponse_nextToken - The token for the next set of results, or null if there are no additional results.

$sel:httpStatus:ListDeploymentsResponse', listDeploymentsResponse_httpStatus - The response's http status code.

Response Lenses

listDeploymentsResponse_deployments :: Lens' ListDeploymentsResponse (Maybe [Deployment]) Source #

A list that summarizes each deployment.

listDeploymentsResponse_nextToken :: Lens' ListDeploymentsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

listDeploymentsResponse_httpStatus :: Lens' ListDeploymentsResponse Int Source #

The response's http status code.