amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.ListStackSetOperations

Description

Returns summary information about operations performed on a stack set.

This operation returns paginated results.

Synopsis

Creating a Request

data ListStackSetOperations Source #

See: newListStackSetOperations smart constructor.

Constructors

ListStackSetOperations' 

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.

  • 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 paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations 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 summaries for.

Instances

Instances details
ToHeaders ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

toHeaders :: ListStackSetOperations -> [Header] #

ToPath ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

toPath :: ListStackSetOperations -> ByteString #

ToQuery ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

toQuery :: ListStackSetOperations -> QueryString #

AWSPager ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

page :: ListStackSetOperations -> AWSResponse ListStackSetOperations -> Maybe ListStackSetOperations #

AWSRequest ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Associated Types

type AWSResponse ListStackSetOperations #

Methods

request :: (Service -> Service) -> ListStackSetOperations -> Request ListStackSetOperations #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListStackSetOperations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStackSetOperations))) #

Generic ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Associated Types

type Rep ListStackSetOperations :: Type -> Type #

Methods

from :: ListStackSetOperations -> Rep ListStackSetOperations x #

to :: Rep ListStackSetOperations x -> ListStackSetOperations #

Read ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

readsPrec :: Int -> ReadS ListStackSetOperations #

readList :: ReadS [ListStackSetOperations] #

readPrec :: ReadPrec ListStackSetOperations #

readListPrec :: ReadPrec [ListStackSetOperations] #

Show ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

showsPrec :: Int -> ListStackSetOperations -> ShowS #

show :: ListStackSetOperations -> String #

showList :: [ListStackSetOperations] -> ShowS #

NFData ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

rnf :: ListStackSetOperations -> () #

Eq ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

(==) :: ListStackSetOperations -> ListStackSetOperations -> Bool #

(/=) :: ListStackSetOperations -> ListStackSetOperations -> Bool #

Hashable ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

hashWithSalt :: Int -> ListStackSetOperations -> Int #

hash :: ListStackSetOperations -> Int #

type AWSResponse ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

type AWSResponse ListStackSetOperations = ListStackSetOperationsResponse
type Rep ListStackSetOperations Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

type Rep ListStackSetOperations = D1 ('MetaData "ListStackSetOperations" "Amazonka.CloudFormation.ListStackSetOperations" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ListStackSetOperations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :*: 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))))

newListStackSetOperations Source #

Arguments

:: Text

ListStackSetOperations

-> ListStackSetOperations 

Create a value of ListStackSetOperations 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:ListStackSetOperations', listStackSetOperations_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:maxResults:ListStackSetOperations', listStackSetOperations_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.

ListStackSetOperations, listStackSetOperations_nextToken - If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations 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.

ListStackSetOperations, listStackSetOperations_stackSetName - The name or unique ID of the stack set that you want to get operation summaries for.

Request Lenses

listStackSetOperations_callAs :: Lens' ListStackSetOperations (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.

listStackSetOperations_maxResults :: Lens' ListStackSetOperations (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.

listStackSetOperations_nextToken :: Lens' ListStackSetOperations (Maybe Text) Source #

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations 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.

listStackSetOperations_stackSetName :: Lens' ListStackSetOperations Text Source #

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

Destructuring the Response

data ListStackSetOperationsResponse Source #

See: newListStackSetOperationsResponse smart constructor.

Constructors

ListStackSetOperationsResponse' 

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 [StackSetOperationSummary]

    A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListStackSetOperationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Associated Types

type Rep ListStackSetOperationsResponse :: Type -> Type #

Methods

from :: ListStackSetOperationsResponse -> Rep ListStackSetOperationsResponse x #

to :: Rep ListStackSetOperationsResponse x -> ListStackSetOperationsResponse #

Read ListStackSetOperationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

readsPrec :: Int -> ReadS ListStackSetOperationsResponse #

readList :: ReadS [ListStackSetOperationsResponse] #

readPrec :: ReadPrec ListStackSetOperationsResponse #

readListPrec :: ReadPrec [ListStackSetOperationsResponse] #

Show ListStackSetOperationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

showsPrec :: Int -> ListStackSetOperationsResponse -> ShowS #

show :: ListStackSetOperationsResponse -> String #

showList :: [ListStackSetOperationsResponse] -> ShowS #

NFData ListStackSetOperationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

rnf :: ListStackSetOperationsResponse -> () #

Eq ListStackSetOperationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

Methods

(==) :: ListStackSetOperationsResponse -> ListStackSetOperationsResponse -> Bool #

(/=) :: ListStackSetOperationsResponse -> ListStackSetOperationsResponse -> Bool #

type Rep ListStackSetOperationsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackSetOperations

type Rep ListStackSetOperationsResponse = D1 ('MetaData "ListStackSetOperationsResponse" "Amazonka.CloudFormation.ListStackSetOperations" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ListStackSetOperationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "summaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StackSetOperationSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStackSetOperationsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListStackSetOperationsResponse'

-> ListStackSetOperationsResponse 

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

ListStackSetOperations, listStackSetOperationsResponse_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:ListStackSetOperationsResponse', listStackSetOperationsResponse_summaries - A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.

$sel:httpStatus:ListStackSetOperationsResponse', listStackSetOperationsResponse_httpStatus - The response's http status code.

Response Lenses

listStackSetOperationsResponse_nextToken :: Lens' ListStackSetOperationsResponse (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.

listStackSetOperationsResponse_summaries :: Lens' ListStackSetOperationsResponse (Maybe [StackSetOperationSummary]) Source #

A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.

listStackSetOperationsResponse_httpStatus :: Lens' ListStackSetOperationsResponse Int Source #

The response's http status code.