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.
Accepts the invitation to be a member account and be monitored by the Security Hub CSPM administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
Parameters:
-
administrator_id
(Optional[NonEmptyString], default:
None
)
–
The account ID of the Security Hub CSPM administrator account that sent the invitation.
-
invitation_id
(Optional[NonEmptyString], default:
None
)
–
The identifier of the invitation sent from the Security Hub CSPM administrator account.
Raises:
Examples:
To accept an invitation be a member account
The following example demonstrates how an account can accept an invitation from the Security Hub administrator account to be a member account. This operation is applicable only to member accounts that are not added through AWS Organizations.
>>> client.accept_administrator_invitation(administrator_id='123456789012', invitation_id='7ab938c5d52d7904ad09f9e7c20cc4eb')
Source code in docs_src/capo_securityhub/_services/security_hub.py
| def accept_administrator_invitation(
self,
*,
config_overrides: Optional[SecurityHubClientConfig] = None,
administrator_id: Optional[
"capo_securityhub.types.non_empty_string.NonEmptyString"
] = None,
invitation_id: Optional[
"capo_securityhub.types.non_empty_string.NonEmptyString"
] = None,
) -> "capo_securityhub.types.accept_administrator_invitation_response.AcceptAdministratorInvitationResponse":
"""<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>Accepts the invitation to be a member account and be monitored by the Security Hub CSPM administrator account that the invitation was sent from.</p> <p>This operation is only used by member accounts that are not added through Organizations.</p> <p>When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.</p>
Args:
administrator_id: <p>The account ID of the Security Hub CSPM administrator account that sent the invitation.</p>
invitation_id: <p>The identifier of the invitation sent from the Security Hub CSPM administrator account.</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.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.</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 accept an invitation be a member account
The following example demonstrates how an account can accept an invitation from the Security Hub administrator account to be a member account. This operation is applicable only to member accounts that are not added through AWS Organizations.
>>> client.accept_administrator_invitation(administrator_id='123456789012', invitation_id='7ab938c5d52d7904ad09f9e7c20cc4eb')
"""
def _handler(
req: "OperationRequest[capo_securityhub.types.accept_administrator_invitation_request.AcceptAdministratorInvitationRequest]",
) -> OperationResponse[
"capo_securityhub.types.accept_administrator_invitation_response.AcceptAdministratorInvitationResponse"
]:
import capo_securityhub._operations.security_hub_api_service.accept_administrator_invitation
output, http_response = (
capo_securityhub._operations.security_hub_api_service.accept_administrator_invitation.accept_administrator_invitation(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("AcceptAdministratorInvitation")
)
input_: capo_securityhub.types.accept_administrator_invitation_request.AcceptAdministratorInvitationRequest = {}
if administrator_id is not None:
input_["administrator_id"] = administrator_id
if invitation_id is not None:
input_["invitation_id"] = invitation_id
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|