Network.AWS.Organizations.ListHandshakesForOrganization

Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake.

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 only from the organization's master account.

This operation returns paginated results.

Creating a Request

listHandshakesForOrganization :: ListHandshakesForOrganization

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

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

• lhfoNextToken - 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.
• lhfoFilter - A filter of 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-ALL-FEATURES , or APPROVE-ALL-FEATURES . Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.
• lhfoMaxResults - (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 ListHandshakesForOrganization

See: listHandshakesForOrganization smart constructor.

Instances

Eq ListHandshakesForOrganization

Methods

(==) :: ListHandshakesForOrganization -> ListHandshakesForOrganization -> Bool

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

Data ListHandshakesForOrganization

Methods

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

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

toConstr :: ListHandshakesForOrganization -> Constr

dataTypeOf :: ListHandshakesForOrganization -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListHandshakesForOrganization

Methods

readsPrec :: Int -> ReadS ListHandshakesForOrganization

readList :: ReadS [ListHandshakesForOrganization]

readPrec :: ReadPrec ListHandshakesForOrganization

readListPrec :: ReadPrec [ListHandshakesForOrganization]

Show ListHandshakesForOrganization

Methods

showsPrec :: Int -> ListHandshakesForOrganization -> ShowS

show :: ListHandshakesForOrganization -> String

showList :: [ListHandshakesForOrganization] -> ShowS

Generic ListHandshakesForOrganization

Associated Types

type Rep ListHandshakesForOrganization :: * -> *

Methods

from :: ListHandshakesForOrganization -> Rep ListHandshakesForOrganization x

to :: Rep ListHandshakesForOrganization x -> ListHandshakesForOrganization

Hashable ListHandshakesForOrganization

Methods

hashWithSalt :: Int -> ListHandshakesForOrganization -> Int

hash :: ListHandshakesForOrganization -> Int

ToJSON ListHandshakesForOrganization

Methods

toJSON :: ListHandshakesForOrganization -> Value

toEncoding :: ListHandshakesForOrganization -> Encoding

toJSONList :: [ListHandshakesForOrganization] -> Value

toEncodingList :: [ListHandshakesForOrganization] -> Encoding

NFData ListHandshakesForOrganization

Methods

rnf :: ListHandshakesForOrganization -> ()

AWSPager ListHandshakesForOrganization

Methods

page :: ListHandshakesForOrganization -> Rs ListHandshakesForOrganization -> Maybe ListHandshakesForOrganization

AWSRequest ListHandshakesForOrganization

Associated Types

type Rs ListHandshakesForOrganization :: *

Methods

request :: ListHandshakesForOrganization -> Request ListHandshakesForOrganization

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

ToHeaders ListHandshakesForOrganization

Methods

toHeaders :: ListHandshakesForOrganization -> [Header]

ToPath ListHandshakesForOrganization

Methods

toPath :: ListHandshakesForOrganization -> ByteString

ToQuery ListHandshakesForOrganization

Methods

toQuery :: ListHandshakesForOrganization -> QueryString

type Rep ListHandshakesForOrganization

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

type Rs ListHandshakesForOrganization

type Rs ListHandshakesForOrganization = ListHandshakesForOrganizationResponse

Request Lenses

lhfoNextToken :: Lens' ListHandshakesForOrganization (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.

lhfoFilter :: Lens' ListHandshakesForOrganization (Maybe HandshakeFilter)

A filter of 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-ALL-FEATURES , or APPROVE-ALL-FEATURES . Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.

lhfoMaxResults :: Lens' ListHandshakesForOrganization (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

listHandshakesForOrganizationResponse

Arguments

:: Int

lhforsResponseStatus

-> ListHandshakesForOrganizationResponse

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

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

• lhforsHandshakes - A list of Handshake objects with details about each of the handshakes that are associated with an organization.
• lhforsNextToken - 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 .
• lhforsResponseStatus - -- | The response status code.

data ListHandshakesForOrganizationResponse

See: listHandshakesForOrganizationResponse smart constructor.

Instances

Eq ListHandshakesForOrganizationResponse

Methods

(==) :: ListHandshakesForOrganizationResponse -> ListHandshakesForOrganizationResponse -> Bool

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

Data ListHandshakesForOrganizationResponse

Methods

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

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

toConstr :: ListHandshakesForOrganizationResponse -> Constr

dataTypeOf :: ListHandshakesForOrganizationResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show ListHandshakesForOrganizationResponse

Methods

showsPrec :: Int -> ListHandshakesForOrganizationResponse -> ShowS

show :: ListHandshakesForOrganizationResponse -> String

showList :: [ListHandshakesForOrganizationResponse] -> ShowS

Generic ListHandshakesForOrganizationResponse

Associated Types

type Rep ListHandshakesForOrganizationResponse :: * -> *

Methods

from :: ListHandshakesForOrganizationResponse -> Rep ListHandshakesForOrganizationResponse x

to :: Rep ListHandshakesForOrganizationResponse x -> ListHandshakesForOrganizationResponse

NFData ListHandshakesForOrganizationResponse

Methods

rnf :: ListHandshakesForOrganizationResponse -> ()

type Rep ListHandshakesForOrganizationResponse

type Rep ListHandshakesForOrganizationResponse = D1 * (MetaData "ListHandshakesForOrganizationResponse" "Network.AWS.Organizations.ListHandshakesForOrganization" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "ListHandshakesForOrganizationResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lhforsHandshakes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Handshake]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lhforsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lhforsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lhforsHandshakes :: Lens' ListHandshakesForOrganizationResponse [Handshake]

A list of Handshake objects with details about each of the handshakes that are associated with an organization.

lhforsNextToken :: Lens' ListHandshakesForOrganizationResponse (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 .

lhforsResponseStatus :: Lens' ListHandshakesForOrganizationResponse Int

• - | The response status code.