Network.AWS.Organizations.ListHandshakesForAccount

Lists the current handshakes that are associated with the account of the requesting user.

Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible.

This operation can be called from any account in the organization.

This operation returns paginated results.

Creating a Request

listHandshakesForAccount :: ListHandshakesForAccount

Creates a value of ListHandshakesForAccount with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lhfaNextToken - Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
• lhfaFilter - Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE , ENABLE-FULL-CONTROL , or APPROVE-FULL-CONTROL . Alternatively, for the ENABLE-FULL-CONTROL handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.
• lhfaMaxResults - (Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

data ListHandshakesForAccount

See: listHandshakesForAccount smart constructor.

Instances

Eq ListHandshakesForAccount

Methods

(==) :: ListHandshakesForAccount -> ListHandshakesForAccount -> Bool

(/=) :: ListHandshakesForAccount -> ListHandshakesForAccount -> Bool

Data ListHandshakesForAccount

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListHandshakesForAccount -> c ListHandshakesForAccount

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListHandshakesForAccount

toConstr :: ListHandshakesForAccount -> Constr

dataTypeOf :: ListHandshakesForAccount -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListHandshakesForAccount)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListHandshakesForAccount)

gmapT :: (forall b. Data b => b -> b) -> ListHandshakesForAccount -> ListHandshakesForAccount

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListHandshakesForAccount -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListHandshakesForAccount -> r

gmapQ :: (forall d. Data d => d -> u) -> ListHandshakesForAccount -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListHandshakesForAccount -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListHandshakesForAccount -> m ListHandshakesForAccount

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListHandshakesForAccount -> m ListHandshakesForAccount

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListHandshakesForAccount -> m ListHandshakesForAccount

Read ListHandshakesForAccount

Methods

readsPrec :: Int -> ReadS ListHandshakesForAccount

readList :: ReadS [ListHandshakesForAccount]

readPrec :: ReadPrec ListHandshakesForAccount

readListPrec :: ReadPrec [ListHandshakesForAccount]

Show ListHandshakesForAccount

Methods

showsPrec :: Int -> ListHandshakesForAccount -> ShowS

show :: ListHandshakesForAccount -> String

showList :: [ListHandshakesForAccount] -> ShowS

Generic ListHandshakesForAccount

Associated Types

type Rep ListHandshakesForAccount :: * -> *

Methods

from :: ListHandshakesForAccount -> Rep ListHandshakesForAccount x

to :: Rep ListHandshakesForAccount x -> ListHandshakesForAccount

Hashable ListHandshakesForAccount

Methods

hashWithSalt :: Int -> ListHandshakesForAccount -> Int

hash :: ListHandshakesForAccount -> Int

ToJSON ListHandshakesForAccount

Methods

toJSON :: ListHandshakesForAccount -> Value

toEncoding :: ListHandshakesForAccount -> Encoding

toJSONList :: [ListHandshakesForAccount] -> Value

toEncodingList :: [ListHandshakesForAccount] -> Encoding

NFData ListHandshakesForAccount

Methods

rnf :: ListHandshakesForAccount -> ()

AWSPager ListHandshakesForAccount

Methods

page :: ListHandshakesForAccount -> Rs ListHandshakesForAccount -> Maybe ListHandshakesForAccount

AWSRequest ListHandshakesForAccount

Associated Types

type Rs ListHandshakesForAccount :: *

Methods

request :: ListHandshakesForAccount -> Request ListHandshakesForAccount

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListHandshakesForAccount -> ClientResponse -> m (Response ListHandshakesForAccount)

ToHeaders ListHandshakesForAccount

Methods

toHeaders :: ListHandshakesForAccount -> [Header]

ToPath ListHandshakesForAccount

Methods

toPath :: ListHandshakesForAccount -> ByteString

ToQuery ListHandshakesForAccount

Methods

toQuery :: ListHandshakesForAccount -> QueryString

type Rep ListHandshakesForAccount

type Rep ListHandshakesForAccount = D1 * (MetaData "ListHandshakesForAccount" "Network.AWS.Organizations.ListHandshakesForAccount" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "ListHandshakesForAccount'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lhfaNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lhfaFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe HandshakeFilter))) (S1 * (MetaSel (Just Symbol "_lhfaMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs ListHandshakesForAccount

type Rs ListHandshakesForAccount = ListHandshakesForAccountResponse

Request Lenses

lhfaNextToken :: Lens' ListHandshakesForAccount (Maybe Text)

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

lhfaFilter :: Lens' ListHandshakesForAccount (Maybe HandshakeFilter)

Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE , ENABLE-FULL-CONTROL , or APPROVE-FULL-CONTROL . Alternatively, for the ENABLE-FULL-CONTROL handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.

lhfaMaxResults :: Lens' ListHandshakesForAccount (Maybe Natural)

(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Destructuring the Response

listHandshakesForAccountResponse

Arguments

:: Int

lhfarsResponseStatus

-> ListHandshakesForAccountResponse

Creates a value of ListHandshakesForAccountResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lhfarsHandshakes - A list of Handshake objects with details about each of the handshakes that is associated with the specified account.
• lhfarsNextToken - If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .
• lhfarsResponseStatus - -- | The response status code.

data ListHandshakesForAccountResponse

See: listHandshakesForAccountResponse smart constructor.

Instances

Eq ListHandshakesForAccountResponse

Methods

(==) :: ListHandshakesForAccountResponse -> ListHandshakesForAccountResponse -> Bool

(/=) :: ListHandshakesForAccountResponse -> ListHandshakesForAccountResponse -> Bool

Data ListHandshakesForAccountResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListHandshakesForAccountResponse -> c ListHandshakesForAccountResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListHandshakesForAccountResponse

toConstr :: ListHandshakesForAccountResponse -> Constr

dataTypeOf :: ListHandshakesForAccountResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListHandshakesForAccountResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListHandshakesForAccountResponse)

gmapT :: (forall b. Data b => b -> b) -> ListHandshakesForAccountResponse -> ListHandshakesForAccountResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListHandshakesForAccountResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListHandshakesForAccountResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListHandshakesForAccountResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListHandshakesForAccountResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListHandshakesForAccountResponse -> m ListHandshakesForAccountResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListHandshakesForAccountResponse -> m ListHandshakesForAccountResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListHandshakesForAccountResponse -> m ListHandshakesForAccountResponse

Show ListHandshakesForAccountResponse

Methods

showsPrec :: Int -> ListHandshakesForAccountResponse -> ShowS

show :: ListHandshakesForAccountResponse -> String

showList :: [ListHandshakesForAccountResponse] -> ShowS

Generic ListHandshakesForAccountResponse

Associated Types

type Rep ListHandshakesForAccountResponse :: * -> *

Methods

from :: ListHandshakesForAccountResponse -> Rep ListHandshakesForAccountResponse x

to :: Rep ListHandshakesForAccountResponse x -> ListHandshakesForAccountResponse

NFData ListHandshakesForAccountResponse

Methods

rnf :: ListHandshakesForAccountResponse -> ()

type Rep ListHandshakesForAccountResponse

type Rep ListHandshakesForAccountResponse = D1 * (MetaData "ListHandshakesForAccountResponse" "Network.AWS.Organizations.ListHandshakesForAccount" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "ListHandshakesForAccountResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lhfarsHandshakes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Handshake]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lhfarsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lhfarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lhfarsHandshakes :: Lens' ListHandshakesForAccountResponse [Handshake]

A list of Handshake objects with details about each of the handshakes that is associated with the specified account.

lhfarsNextToken :: Lens' ListHandshakesForAccountResponse (Maybe Text)

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .

lhfarsResponseStatus :: Lens' ListHandshakesForAccountResponse Int

• - | The response status code.