Class: Aws::Detective::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb

Overview

An API client for Detective. To construct a client, you need to configure a :region and :credentials.

client = Aws::Detective::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



348
349
350
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 348

def initialize(*args)
  super
end

Instance Method Details

#accept_invitation(params = {}) ⇒ Struct

Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.

The request provides the ARN of behavior graph.

The member account status in the graph must be INVITED.

Examples:

Request syntax with placeholder values


resp = client.accept_invitation({
  graph_arn: "GraphArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the behavior graph that the member account is accepting the invitation for.

    The member account status in the behavior graph must be INVITED.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



380
381
382
383
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 380

def accept_invitation(params = {}, options = {})
  req = build_request(:accept_invitation, params)
  req.send_request(options)
end

#create_graph(params = {}) ⇒ Types::CreateGraphResponse

Creates a new behavior graph for the calling account, and sets that account as the administrator account. This operation is called by the account that is enabling Detective.

Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective.

The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.

CreateGraph triggers a process to create the corresponding data tables for the new behavior graph.

An account can only be the administrator account for one behavior graph within a Region. If the same account calls CreateGraph with the same administrator account, it always returns the same behavior graph ARN. It does not create a new behavior graph.

Examples:

Request syntax with placeholder values


resp = client.create_graph({
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.graph_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :tags (Hash<String,String>)

    The tags to assign to the new behavior graph. You can add up to 50 tags. For each tag, you provide the tag key and the tag value. Each tag key can contain up to 128 characters. Each tag value can contain up to 256 characters.

Returns:

See Also:



434
435
436
437
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 434

def create_graph(params = {}, options = {})
  req = build_request(:create_graph, params)
  req.send_request(options)
end

#create_members(params = {}) ⇒ Types::CreateMembersResponse

CreateMembers is used to send invitations to accounts. For the organization behavior graph, the Detective administrator account uses CreateMembers to enable organization accounts as member accounts.

For invited accounts, CreateMembers sends a request to invite the specified Amazon Web Services accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph.

CreateMembers verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally.

For organization accounts in the organization behavior graph, CreateMembers attempts to enable the accounts. The organization accounts do not receive invitations.

The request provides the behavior graph ARN and the list of accounts to invite or to enable.

The response separates the requested accounts into two lists:

  • The accounts that CreateMembers was able to process. For invited accounts, includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification. For organization accounts in the organization behavior graph, includes accounts that can be enabled and that cannot be enabled.

  • The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.

Examples:

Request syntax with placeholder values


resp = client.create_members({
  graph_arn: "GraphArn", # required
  message: "EmailMessage",
  disable_email_notification: false,
  accounts: [ # required
    {
      account_id: "AccountId", # required
      email_address: "EmailAddress", # required
    },
  ],
})

Response structure


resp.members #=> Array
resp.members[0]. #=> String
resp.members[0].email_address #=> String
resp.members[0].graph_arn #=> String
resp.members[0].master_id #=> String
resp.members[0].administrator_id #=> String
resp.members[0].status #=> String, one of "INVITED", "VERIFICATION_IN_PROGRESS", "VERIFICATION_FAILED", "ENABLED", "ACCEPTED_BUT_DISABLED"
resp.members[0].disabled_reason #=> String, one of "VOLUME_TOO_HIGH", "VOLUME_UNKNOWN"
resp.members[0].invited_time #=> Time
resp.members[0].updated_time #=> Time
resp.members[0].volume_usage_in_bytes #=> Integer
resp.members[0].volume_usage_updated_time #=> Time
resp.members[0].percent_of_graph_utilization #=> Float
resp.members[0].percent_of_graph_utilization_updated_time #=> Time
resp.members[0].invitation_type #=> String, one of "INVITATION", "ORGANIZATION"
resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0]. #=> String
resp.unprocessed_accounts[0].reason #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the behavior graph.

  • :message (String)

    Customized message text to include in the invitation email message to the invited member accounts.

  • :disable_email_notification (Boolean)

    if set to true, then the invited accounts do not receive email notifications. By default, this is set to false, and the invited accounts receive email notifications.

    Organization accounts in the organization behavior graph do not receive email notifications.

  • :accounts (required, Array<Types::Account>)

    The list of Amazon Web Services accounts to invite or to enable. You can invite or enable up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the Amazon Web Services account root user email address. For organization accounts in the organization behavior graph, the email address is not required.

Returns:

See Also:



540
541
542
543
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 540

def create_members(params = {}, options = {})
  req = build_request(:create_members, params)
  req.send_request(options)
end

#delete_graph(params = {}) ⇒ Struct

Disables the specified behavior graph and queues it to be deleted. This operation removes the behavior graph from each member account's list of behavior graphs.

DeleteGraph can only be called by the administrator account for a behavior graph.

Examples:

Request syntax with placeholder values


resp = client.delete_graph({
  graph_arn: "GraphArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the behavior graph to disable.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



567
568
569
570
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 567

def delete_graph(params = {}, options = {})
  req = build_request(:delete_graph, params)
  req.send_request(options)
end

#delete_members(params = {}) ⇒ Types::DeleteMembersResponse

Removes the specified member accounts from the behavior graph. The removed accounts no longer contribute data to the behavior graph. This operation can only be called by the administrator account for the behavior graph.

For invited accounts, the removed accounts are deleted from the list of accounts in the behavior graph. To restore the account, the administrator account must send another invitation.

For organization accounts in the organization behavior graph, the Detective administrator account can always enable the organization account again. Organization accounts that are not enabled as member accounts are not included in the ListMembers results for the organization behavior graph.

An administrator account cannot use DeleteMembers to remove their own account from the behavior graph. To disable a behavior graph, the administrator account uses the DeleteGraph API method.

Examples:

Request syntax with placeholder values


resp = client.delete_members({
  graph_arn: "GraphArn", # required
  account_ids: ["AccountId"], # required
})

Response structure


resp. #=> Array
resp.[0] #=> String
resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0]. #=> String
resp.unprocessed_accounts[0].reason #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the behavior graph to remove members from.

  • :account_ids (required, Array<String>)

    The list of Amazon Web Services account identifiers for the member accounts to remove from the behavior graph. You can remove up to 50 member accounts at a time.

Returns:

See Also:



623
624
625
626
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 623

def delete_members(params = {}, options = {})
  req = build_request(:delete_members, params)
  req.send_request(options)
end

#describe_organization_configuration(params = {}) ⇒ Types::DescribeOrganizationConfigurationResponse

Returns information about the configuration for the organization behavior graph. Currently indicates whether to automatically enable new organization accounts as member accounts.

Can only be called by the Detective administrator account for the organization.

Examples:

Request syntax with placeholder values


resp = client.describe_organization_configuration({
  graph_arn: "GraphArn", # required
})

Response structure


resp.auto_enable #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the organization behavior graph.

Returns:

See Also:



656
657
658
659
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 656

def describe_organization_configuration(params = {}, options = {})
  req = build_request(:describe_organization_configuration, params)
  req.send_request(options)
end

#disable_organization_admin_account(params = {}) ⇒ Struct

Removes the Detective administrator account for the organization in the current Region. Deletes the behavior graph for that account.

Can only be called by the organization management account. Before you can select a different Detective administrator account, you must remove the Detective administrator account in all Regions.

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



674
675
676
677
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 674

def (params = {}, options = {})
  req = build_request(:disable_organization_admin_account, params)
  req.send_request(options)
end

#disassociate_membership(params = {}) ⇒ Struct

Removes the member account from the specified behavior graph. This operation can only be called by an invited member account that has the ENABLED status.

DisassociateMembership cannot be called by an organization account in the organization behavior graph. For the organization behavior graph, the Detective administrator account determines which organization accounts to enable or disable as member accounts.

Examples:

Request syntax with placeholder values


resp = client.disassociate_membership({
  graph_arn: "GraphArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the behavior graph to remove the member account from.

    The member account's member status in the behavior graph must be ENABLED.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



706
707
708
709
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 706

def disassociate_membership(params = {}, options = {})
  req = build_request(:disassociate_membership, params)
  req.send_request(options)
end

#enable_organization_admin_account(params = {}) ⇒ Struct

Designates the Detective administrator account for the organization in the current Region.

If the account does not have Detective enabled, then enables Detective for that account and creates a new behavior graph.

Can only be called by the organization management account.

The Detective administrator account for an organization must be the same in all Regions. If you already designated a Detective administrator account in another Region, then you must designate the same account.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "AccountId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :account_id (required, String)

    The Amazon Web Services account identifier of the account to designate as the Detective administrator account for the organization.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



740
741
742
743
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 740

def (params = {}, options = {})
  req = build_request(:enable_organization_admin_account, params)
  req.send_request(options)
end

#get_members(params = {}) ⇒ Types::GetMembersResponse

Returns the membership details for specified member accounts for a behavior graph.

Examples:

Request syntax with placeholder values


resp = client.get_members({
  graph_arn: "GraphArn", # required
  account_ids: ["AccountId"], # required
})

Response structure


resp.member_details #=> Array
resp.member_details[0]. #=> String
resp.member_details[0].email_address #=> String
resp.member_details[0].graph_arn #=> String
resp.member_details[0].master_id #=> String
resp.member_details[0].administrator_id #=> String
resp.member_details[0].status #=> String, one of "INVITED", "VERIFICATION_IN_PROGRESS", "VERIFICATION_FAILED", "ENABLED", "ACCEPTED_BUT_DISABLED"
resp.member_details[0].disabled_reason #=> String, one of "VOLUME_TOO_HIGH", "VOLUME_UNKNOWN"
resp.member_details[0].invited_time #=> Time
resp.member_details[0].updated_time #=> Time
resp.member_details[0].volume_usage_in_bytes #=> Integer
resp.member_details[0].volume_usage_updated_time #=> Time
resp.member_details[0].percent_of_graph_utilization #=> Float
resp.member_details[0].percent_of_graph_utilization_updated_time #=> Time
resp.member_details[0].invitation_type #=> String, one of "INVITATION", "ORGANIZATION"
resp.unprocessed_accounts #=> Array
resp.unprocessed_accounts[0]. #=> String
resp.unprocessed_accounts[0].reason #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the behavior graph for which to request the member details.

  • :account_ids (required, Array<String>)

    The list of Amazon Web Services account identifiers for the member account for which to return member details. You can request details for up to 50 member accounts at a time.

    You cannot use GetMembers to retrieve information about member accounts that were removed from the behavior graph.

Returns:

See Also:



796
797
798
799
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 796

def get_members(params = {}, options = {})
  req = build_request(:get_members, params)
  req.send_request(options)
end

#list_graphs(params = {}) ⇒ Types::ListGraphsResponse

Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account.

Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_graphs({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.graph_list #=> Array
resp.graph_list[0].arn #=> String
resp.graph_list[0].created_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.

  • :max_results (Integer)

    The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.

Returns:

See Also:



844
845
846
847
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 844

def list_graphs(params = {}, options = {})
  req = build_request(:list_graphs, params)
  req.send_request(options)
end

#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse

Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by an invited member account.

Open invitations are invitations that the member account has not responded to.

The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_invitations({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.invitations #=> Array
resp.invitations[0]. #=> String
resp.invitations[0].email_address #=> String
resp.invitations[0].graph_arn #=> String
resp.invitations[0].master_id #=> String
resp.invitations[0].administrator_id #=> String
resp.invitations[0].status #=> String, one of "INVITED", "VERIFICATION_IN_PROGRESS", "VERIFICATION_FAILED", "ENABLED", "ACCEPTED_BUT_DISABLED"
resp.invitations[0].disabled_reason #=> String, one of "VOLUME_TOO_HIGH", "VOLUME_UNKNOWN"
resp.invitations[0].invited_time #=> Time
resp.invitations[0].updated_time #=> Time
resp.invitations[0].volume_usage_in_bytes #=> Integer
resp.invitations[0].volume_usage_updated_time #=> Time
resp.invitations[0].percent_of_graph_utilization #=> Float
resp.invitations[0].percent_of_graph_utilization_updated_time #=> Time
resp.invitations[0].invitation_type #=> String, one of "INVITATION", "ORGANIZATION"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    For requests to retrieve the next page of results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.

  • :max_results (Integer)

    The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.

Returns:

See Also:



908
909
910
911
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 908

def list_invitations(params = {}, options = {})
  req = build_request(:list_invitations, params)
  req.send_request(options)
end

#list_members(params = {}) ⇒ Types::ListMembersResponse

Retrieves the list of member accounts for a behavior graph.

For invited accounts, the results do not include member accounts that were removed from the behavior graph.

For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_members({
  graph_arn: "GraphArn", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.member_details #=> Array
resp.member_details[0]. #=> String
resp.member_details[0].email_address #=> String
resp.member_details[0].graph_arn #=> String
resp.member_details[0].master_id #=> String
resp.member_details[0].administrator_id #=> String
resp.member_details[0].status #=> String, one of "INVITED", "VERIFICATION_IN_PROGRESS", "VERIFICATION_FAILED", "ENABLED", "ACCEPTED_BUT_DISABLED"
resp.member_details[0].disabled_reason #=> String, one of "VOLUME_TOO_HIGH", "VOLUME_UNKNOWN"
resp.member_details[0].invited_time #=> Time
resp.member_details[0].updated_time #=> Time
resp.member_details[0].volume_usage_in_bytes #=> Integer
resp.member_details[0].volume_usage_updated_time #=> Time
resp.member_details[0].percent_of_graph_utilization #=> Float
resp.member_details[0].percent_of_graph_utilization_updated_time #=> Time
resp.member_details[0].invitation_type #=> String, one of "INVITATION", "ORGANIZATION"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the behavior graph for which to retrieve the list of member accounts.

  • :next_token (String)

    For requests to retrieve the next page of member account results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.

  • :max_results (Integer)

    The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.

Returns:

See Also:



974
975
976
977
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 974

def list_members(params = {}, options = {})
  req = build_request(:list_members, params)
  req.send_request(options)
end

#list_organization_admin_accounts(params = {}) ⇒ Types::ListOrganizationAdminAccountsResponse

Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_organization_admin_accounts({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.administrators #=> Array
resp.administrators[0]. #=> String
resp.administrators[0].graph_arn #=> String
resp.administrators[0].delegation_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.

  • :max_results (Integer)

    The maximum number of results to return.

Returns:

See Also:



1017
1018
1019
1020
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 1017

def list_organization_admin_accounts(params = {}, options = {})
  req = build_request(:list_organization_admin_accounts, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns the tag values that are assigned to a behavior graph.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "GraphArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The ARN of the behavior graph for which to retrieve the tag values.

Returns:

See Also:



1046
1047
1048
1049
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 1046

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#reject_invitation(params = {}) ⇒ Struct

Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by an invited member account that has the INVITED status.

RejectInvitation cannot be called by an organization account in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation.

Examples:

Request syntax with placeholder values


resp = client.reject_invitation({
  graph_arn: "GraphArn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the behavior graph to reject the invitation to.

    The member account's current member status in the behavior graph must be INVITED.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1077
1078
1079
1080
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 1077

def reject_invitation(params = {}, options = {})
  req = build_request(:reject_invitation, params)
  req.send_request(options)
end

#start_monitoring_member(params = {}) ⇒ Struct

Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED.

For valid member accounts, the status is updated as follows.

  • If Detective enabled the member account, then the new status is ENABLED.

  • If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED.

Examples:

Request syntax with placeholder values


resp = client.start_monitoring_member({
  graph_arn: "GraphArn", # required
  account_id: "AccountId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the behavior graph.

  • :account_id (required, String)

    The account ID of the member account to try to enable.

    The account must be an invited member account with a status of ACCEPTED_BUT_DISABLED.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1115
1116
1117
1118
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 1115

def start_monitoring_member(params = {}, options = {})
  req = build_request(:start_monitoring_member, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Applies tag values to a behavior graph.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "GraphArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The ARN of the behavior graph to assign the tags to.

  • :tags (required, Hash<String,String>)

    The tags to assign to the behavior graph. You can add up to 50 tags. For each tag, you provide the tag key and the tag value. Each tag key can contain up to 128 characters. Each tag value can contain up to 256 characters.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1146
1147
1148
1149
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 1146

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from a behavior graph.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "GraphArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The ARN of the behavior graph to remove the tags from.

  • :tag_keys (required, Array<String>)

    The tag keys of the tags to remove from the behavior graph. You can remove up to 50 tags at a time.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1173
1174
1175
1176
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 1173

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_organization_configuration(params = {}) ⇒ Struct

Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.

Examples:

Request syntax with placeholder values


resp = client.update_organization_configuration({
  graph_arn: "GraphArn", # required
  auto_enable: false,
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :graph_arn (required, String)

    The ARN of the organization behavior graph.

  • :auto_enable (Boolean)

    Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1202
1203
1204
1205
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 1202

def update_organization_configuration(params = {}, options = {})
  req = build_request(:update_organization_configuration, params)
  req.send_request(options)
end