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.CloudFormation.ListStackSetOperationResults

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns summary information about the results of a stack set operation.

This operation returns paginated results.

Synopsis

Creating a Request

data ListStackSetOperationResults Source #

See: newListStackSetOperationResults smart constructor.

Constructors

ListStackSetOperationResults'

Fields

callAs :: Maybe CallAs
Service-managed permissions
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
- If you are signed in to the management account, specify SELF.
- If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
filters :: Maybe [OperationResultFilter]
The filter to apply to operation results.
maxResults :: Maybe Natural
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
nextToken :: Maybe Text
If the previous request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
stackSetName :: Text
The name or unique ID of the stack set that you want to get operation results for.
operationId :: Text
The ID of the stack set operation.

Instances

Instances details

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

newListStackSetOperationResults Source #

Arguments

:: Text	`ListStackSetOperationResults`
-> Text	`ListStackSetOperationResults`
-> ListStackSetOperationResults

Create a value of ListStackSetOperationResults 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:callAs:ListStackSetOperationResults', listStackSetOperationResults_callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

$sel:filters:ListStackSetOperationResults', listStackSetOperationResults_filters - The filter to apply to operation results.

$sel:maxResults:ListStackSetOperationResults', listStackSetOperationResults_maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

ListStackSetOperationResults, listStackSetOperationResults_nextToken - If the previous request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

ListStackSetOperationResults, listStackSetOperationResults_stackSetName - The name or unique ID of the stack set that you want to get operation results for.

ListStackSetOperationResults, listStackSetOperationResults_operationId - The ID of the stack set operation.

Request Lenses

listStackSetOperationResults_callAs :: Lens' ListStackSetOperationResults (Maybe CallAs) Source #

Service-managed permissions: Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

listStackSetOperationResults_filters :: Lens' ListStackSetOperationResults (Maybe [OperationResultFilter]) Source #

The filter to apply to operation results.

listStackSetOperationResults_maxResults :: Lens' ListStackSetOperationResults (Maybe Natural) Source #

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

listStackSetOperationResults_nextToken :: Lens' ListStackSetOperationResults (Maybe Text) Source #

If the previous request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listStackSetOperationResults_stackSetName :: Lens' ListStackSetOperationResults Text Source #

The name or unique ID of the stack set that you want to get operation results for.

listStackSetOperationResults_operationId :: Lens' ListStackSetOperationResults Text Source #

The ID of the stack set operation.

Destructuring the Response

data ListStackSetOperationResultsResponse Source #

See: newListStackSetOperationResultsResponse smart constructor.

Constructors

ListStackSetOperationResultsResponse'

Fields

nextToken :: Maybe Text
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.
summaries :: Maybe [StackSetOperationResultSummary]
A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListStackSetOperationResultsResponse Source #

Arguments

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

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

ListStackSetOperationResults, listStackSetOperationResultsResponse_nextToken - If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

$sel:summaries:ListStackSetOperationResultsResponse', listStackSetOperationResultsResponse_summaries - A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.

$sel:httpStatus:ListStackSetOperationResultsResponse', listStackSetOperationResultsResponse_httpStatus - The response's http status code.

Response Lenses

listStackSetOperationResultsResponse_nextToken :: Lens' ListStackSetOperationResultsResponse (Maybe Text) Source #

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

listStackSetOperationResultsResponse_summaries :: Lens' ListStackSetOperationResultsResponse (Maybe [StackSetOperationResultSummary]) Source #

A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.

listStackSetOperationResultsResponse_httpStatus :: Lens' ListStackSetOperationResultsResponse Int Source #

The response's http status code.