DetectiveClient
Auto-generated documentation for Detective type annotations stubs module mypy-boto3-detective.
DetectiveClient
Type annotations and code completion for boto3.client("detective")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_detective.client import DetectiveClient
def get_detective_client() -> DetectiveClient:
return Session().client("detective")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("detective").exceptions
structure.
client = boto3.client("detective")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.TooManyRequestsException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_detective.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
accept_invitation
Accepts an invitation for the member account to contribute data to a behavior graph.
Type annotations and code completion for boto3.client("detective").accept_invitation
method.
boto3 documentation
def accept_invitation(
self,
*,
GraphArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AcceptInvitationRequestRequestTypeDef = { # (1)
"GraphArn": ...,
}
parent.accept_invitation(**kwargs)
batch_get_graph_member_datasources
Gets data source package information for the behavior graph.
Type annotations and code completion for boto3.client("detective").batch_get_graph_member_datasources
method.
boto3 documentation
def batch_get_graph_member_datasources(
self,
*,
GraphArn: str,
AccountIds: Sequence[str],
) -> BatchGetGraphMemberDatasourcesResponseTypeDef: # (1)
...
kwargs: BatchGetGraphMemberDatasourcesRequestRequestTypeDef = { # (1)
"GraphArn": ...,
"AccountIds": ...,
}
parent.batch_get_graph_member_datasources(**kwargs)
batch_get_membership_datasources
Gets information on the data source package history for an account.
Type annotations and code completion for boto3.client("detective").batch_get_membership_datasources
method.
boto3 documentation
def batch_get_membership_datasources(
self,
*,
GraphArns: Sequence[str],
) -> BatchGetMembershipDatasourcesResponseTypeDef: # (1)
...
kwargs: BatchGetMembershipDatasourcesRequestRequestTypeDef = { # (1)
"GraphArns": ...,
}
parent.batch_get_membership_datasources(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("detective").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("detective").close
method.
boto3 documentation
create_graph
Creates a new behavior graph for the calling account, and sets that account as the administrator account.
Type annotations and code completion for boto3.client("detective").create_graph
method.
boto3 documentation
def create_graph(
self,
*,
Tags: Mapping[str, str] = ...,
) -> CreateGraphResponseTypeDef: # (1)
...
kwargs: CreateGraphRequestRequestTypeDef = { # (1)
"Tags": ...,
}
parent.create_graph(**kwargs)
create_members
CreateMembers
is used to send invitations to accounts.
Type annotations and code completion for boto3.client("detective").create_members
method.
boto3 documentation
def create_members(
self,
*,
GraphArn: str,
Accounts: Sequence[AccountTypeDef], # (1)
Message: str = ...,
DisableEmailNotification: bool = ...,
) -> CreateMembersResponseTypeDef: # (2)
...
kwargs: CreateMembersRequestRequestTypeDef = { # (1)
"GraphArn": ...,
"Accounts": ...,
}
parent.create_members(**kwargs)
delete_graph
Disables the specified behavior graph and queues it to be deleted.
Type annotations and code completion for boto3.client("detective").delete_graph
method.
boto3 documentation
def delete_graph(
self,
*,
GraphArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteGraphRequestRequestTypeDef = { # (1)
"GraphArn": ...,
}
parent.delete_graph(**kwargs)
delete_members
Removes the specified member accounts from the behavior graph.
Type annotations and code completion for boto3.client("detective").delete_members
method.
boto3 documentation
def delete_members(
self,
*,
GraphArn: str,
AccountIds: Sequence[str],
) -> DeleteMembersResponseTypeDef: # (1)
...
kwargs: DeleteMembersRequestRequestTypeDef = { # (1)
"GraphArn": ...,
"AccountIds": ...,
}
parent.delete_members(**kwargs)
describe_organization_configuration
Returns information about the configuration for the organization behavior graph.
Type annotations and code completion for boto3.client("detective").describe_organization_configuration
method.
boto3 documentation
def describe_organization_configuration(
self,
*,
GraphArn: str,
) -> DescribeOrganizationConfigurationResponseTypeDef: # (1)
...
kwargs: DescribeOrganizationConfigurationRequestRequestTypeDef = { # (1)
"GraphArn": ...,
}
parent.describe_organization_configuration(**kwargs)
disable_organization_admin_account
Removes the Detective administrator account in the current Region.
Type annotations and code completion for boto3.client("detective").disable_organization_admin_account
method.
boto3 documentation
def disable_organization_admin_account(
self,
) -> EmptyResponseMetadataTypeDef: # (1)
...
disassociate_membership
Removes the member account from the specified behavior graph.
Type annotations and code completion for boto3.client("detective").disassociate_membership
method.
boto3 documentation
def disassociate_membership(
self,
*,
GraphArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisassociateMembershipRequestRequestTypeDef = { # (1)
"GraphArn": ...,
}
parent.disassociate_membership(**kwargs)
enable_organization_admin_account
Designates the Detective administrator account for the organization in the current Region.
Type annotations and code completion for boto3.client("detective").enable_organization_admin_account
method.
boto3 documentation
def enable_organization_admin_account(
self,
*,
AccountId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: EnableOrganizationAdminAccountRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.enable_organization_admin_account(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("detective").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_members
Returns the membership details for specified member accounts for a behavior graph.
Type annotations and code completion for boto3.client("detective").get_members
method.
boto3 documentation
def get_members(
self,
*,
GraphArn: str,
AccountIds: Sequence[str],
) -> GetMembersResponseTypeDef: # (1)
...
kwargs: GetMembersRequestRequestTypeDef = { # (1)
"GraphArn": ...,
"AccountIds": ...,
}
parent.get_members(**kwargs)
list_datasource_packages
Lists data source packages in the behavior graph.
Type annotations and code completion for boto3.client("detective").list_datasource_packages
method.
boto3 documentation
def list_datasource_packages(
self,
*,
GraphArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDatasourcePackagesResponseTypeDef: # (1)
...
kwargs: ListDatasourcePackagesRequestRequestTypeDef = { # (1)
"GraphArn": ...,
}
parent.list_datasource_packages(**kwargs)
list_graphs
Returns the list of behavior graphs that the calling account is an administrator account of.
Type annotations and code completion for boto3.client("detective").list_graphs
method.
boto3 documentation
def list_graphs(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListGraphsResponseTypeDef: # (1)
...
kwargs: ListGraphsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_graphs(**kwargs)
list_invitations
Retrieves the list of open and accepted behavior graph invitations for the member account.
Type annotations and code completion for boto3.client("detective").list_invitations
method.
boto3 documentation
def list_invitations(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListInvitationsResponseTypeDef: # (1)
...
kwargs: ListInvitationsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_invitations(**kwargs)
list_members
Retrieves the list of member accounts for a behavior graph.
Type annotations and code completion for boto3.client("detective").list_members
method.
boto3 documentation
def list_members(
self,
*,
GraphArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListMembersResponseTypeDef: # (1)
...
kwargs: ListMembersRequestRequestTypeDef = { # (1)
"GraphArn": ...,
}
parent.list_members(**kwargs)
list_organization_admin_accounts
Returns information about the Detective administrator account for an organization.
Type annotations and code completion for boto3.client("detective").list_organization_admin_accounts
method.
boto3 documentation
def list_organization_admin_accounts(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListOrganizationAdminAccountsResponseTypeDef: # (1)
...
kwargs: ListOrganizationAdminAccountsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_organization_admin_accounts(**kwargs)
list_tags_for_resource
Returns the tag values that are assigned to a behavior graph.
Type annotations and code completion for boto3.client("detective").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
reject_invitation
Rejects an invitation to contribute the account data to a behavior graph.
Type annotations and code completion for boto3.client("detective").reject_invitation
method.
boto3 documentation
def reject_invitation(
self,
*,
GraphArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RejectInvitationRequestRequestTypeDef = { # (1)
"GraphArn": ...,
}
parent.reject_invitation(**kwargs)
start_monitoring_member
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED
.
Type annotations and code completion for boto3.client("detective").start_monitoring_member
method.
boto3 documentation
def start_monitoring_member(
self,
*,
GraphArn: str,
AccountId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StartMonitoringMemberRequestRequestTypeDef = { # (1)
"GraphArn": ...,
"AccountId": ...,
}
parent.start_monitoring_member(**kwargs)
tag_resource
Applies tag values to a behavior graph.
Type annotations and code completion for boto3.client("detective").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from a behavior graph.
Type annotations and code completion for boto3.client("detective").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_datasource_packages
Starts a data source packages for the behavior graph.
Type annotations and code completion for boto3.client("detective").update_datasource_packages
method.
boto3 documentation
def update_datasource_packages(
self,
*,
GraphArn: str,
DatasourcePackages: Sequence[DatasourcePackageType], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateDatasourcePackagesRequestRequestTypeDef = { # (1)
"GraphArn": ...,
"DatasourcePackages": ...,
}
parent.update_datasource_packages(**kwargs)
update_organization_configuration
Updates the configuration for the Organizations integration in the current Region.
Type annotations and code completion for boto3.client("detective").update_organization_configuration
method.
boto3 documentation
def update_organization_configuration(
self,
*,
GraphArn: str,
AutoEnable: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...