We recommend using Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see Managing Security Hub CSPM administrator and member accounts with Organizations in the Security Hub CSPM User Guide.
Declines invitations to become a Security Hub CSPM member account.
A prospective member account uses this operation to decline an invitation to become a member.
Only member accounts that aren't part of an Amazon Web Services organization should use this operation. Organization accounts don't receive invitations.
Parameters:
-
account_ids
(Optional[AccountIdList], default:
None
)
–
The list of prospective member account IDs for which to decline an invitation.
Raises:
Examples:
To decline invitation to become a member account
The following example declines an invitation from the Security Hub administrator account to become a member account. The invited account makes the request.
>>> await client.decline_invitations(account_ids=['123456789012', '111122223333'])
Source code in docs_src/capo_securityhub/_services/async_security_hub.py
| async def decline_invitations(
self,
*,
config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
account_ids: Optional[
"capo_securityhub.types.account_id_list.AccountIdList"
] = None,
) -> (
"capo_securityhub.types.decline_invitations_response.DeclineInvitationsResponse"
):
"""<note> <p>We recommend using Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html">Managing Security Hub CSPM administrator and member accounts with Organizations</a> in the <i>Security Hub CSPM User Guide</i>.</p> </note> <p>Declines invitations to become a Security Hub CSPM member account.</p> <p>A prospective member account uses this operation to decline an invitation to become a member.</p> <p>Only member accounts that aren't part of an Amazon Web Services organization should use this operation. Organization accounts don't receive invitations.</p>
Args:
account_ids: <p>The list of prospective member account IDs for which to decline an invitation.</p>
Raises:
capo_securityhub.errors.internal_exception.InternalException: <p>Internal server error.</p>
capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
capo_securityhub.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
capo_securityhub.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because we can't find the specified resource.</p>
capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To decline invitation to become a member account
The following example declines an invitation from the Security Hub administrator account to become a member account. The invited account makes the request.
>>> await client.decline_invitations(account_ids=['123456789012', '111122223333'])
"""
async def _handler(
req: "AsyncOperationRequest[capo_securityhub.types.decline_invitations_request.DeclineInvitationsRequest]",
) -> AsyncOperationResponse[
"capo_securityhub.types.decline_invitations_response.DeclineInvitationsResponse"
]:
import capo_securityhub._operations.security_hub_api_service.decline_invitations
(
output,
http_response,
) = await capo_securityhub._operations.security_hub_api_service.decline_invitations.async_decline_invitations(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeclineInvitations")
)
input_: capo_securityhub.types.decline_invitations_request.DeclineInvitationsRequest = {}
if account_ids is not None:
input_["account_ids"] = account_ids
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|