Skip to content

accept_invitation

Operation

accept_invitation

accept_invitation(request: AcceptInvitationInput | AcceptInvitationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AcceptInvitationInputDict]) -> AcceptInvitationOutput

Accepts the invitation to be monitored by a GuardDuty administrator account.

Parameters:

Name Type Description Default
request AcceptInvitationInput | AcceptInvitationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[AcceptInvitationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AcceptInvitationOutput

An instance of AcceptInvitationOutput.

accept_invitation async

accept_invitation(request: AcceptInvitationInput | AcceptInvitationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AcceptInvitationInputDict]) -> AcceptInvitationOutput

Accepts the invitation to be monitored by a GuardDuty administrator account.

Parameters:

Name Type Description Default
request AcceptInvitationInput | AcceptInvitationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[AcceptInvitationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AcceptInvitationOutput

An instance of AcceptInvitationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

AcceptInvitationInputDict

Bases: TypedDict

Dictionary form of AcceptInvitationInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the detector of the GuardDuty member account.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

invitation_id instance-attribute
invitation_id: Required[str]

The value that is used to validate the administrator account to the member account.

master_id instance-attribute
master_id: Required[str]

The account ID of the GuardDuty administrator account whose invitation you're accepting.

AcceptInvitationInput dataclass

Bases: _SerdeShape

Dataclass for AcceptInvitationInput structure.

Attributes

detector_id class-attribute instance-attribute
detector_id: str | None = ...

The unique ID of the detector of the GuardDuty member account.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

invitation_id class-attribute instance-attribute
invitation_id: str | None = ...

The value that is used to validate the administrator account to the member account.

master_id class-attribute instance-attribute
master_id: str | None = ...

The account ID of the GuardDuty administrator account whose invitation you're accepting.

Output

AcceptInvitationOutput dataclass

Bases: _SerdeShape

Dataclass for AcceptInvitationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.