GuardDutyClient
extends AwsClient
in package
This client is used to interact with the **Amazon GuardDuty** service.
Table of Contents
- $aliases : array<string|int, mixed>
- $api : Service
- $config : array<string|int, mixed>
- $credentialProvider : callable
- $defaultRequestOptions : array<string|int, mixed>
- $endpoint : string
- $handlerList : HandlerList
- $region : string
- $signatureProvider : callable
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- acceptInvitation() :
- acceptInvitationAsync() :
- archiveFindings() :
- archiveFindingsAsync() :
- createDetector() :
- createDetectorAsync() :
- createFilter() :
- createFilterAsync() :
- createIPSet() :
- createIPSetAsync() :
- createMembers() :
- createMembersAsync() :
- createPublishingDestination() :
- createPublishingDestinationAsync() :
- createSampleFindings() :
- createSampleFindingsAsync() :
- createThreatIntelSet() :
- createThreatIntelSetAsync() :
- declineInvitations() :
- declineInvitationsAsync() :
- deleteDetector() :
- deleteDetectorAsync() :
- deleteFilter() :
- deleteFilterAsync() :
- deleteInvitations() :
- deleteInvitationsAsync() :
- deleteIPSet() :
- deleteIPSetAsync() :
- deleteMembers() :
- deleteMembersAsync() :
- deletePublishingDestination() :
- deletePublishingDestinationAsync() :
- deleteThreatIntelSet() :
- deleteThreatIntelSetAsync() :
- describeOrganizationConfiguration() :
- describeOrganizationConfigurationAsync() :
- describePublishingDestination() :
- describePublishingDestinationAsync() :
- disableOrganizationAdminAccount() :
- disableOrganizationAdminAccountAsync() :
- disassociateFromMasterAccount() :
- disassociateFromMasterAccountAsync() :
- disassociateMembers() :
- disassociateMembersAsync() :
- enableOrganizationAdminAccount() :
- enableOrganizationAdminAccountAsync() :
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getDetector() :
- getDetectorAsync() :
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getFilter() :
- getFilterAsync() :
- getFindings() :
- getFindingsAsync() :
- getFindingsStatistics() :
- getFindingsStatisticsAsync() :
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getInvitationsCount() :
- getInvitationsCountAsync() :
- getIPSet() :
- getIPSetAsync() :
- getIterator() : mixed
- getMasterAccount() :
- getMasterAccountAsync() :
- getMemberDetectors() :
- getMemberDetectorsAsync() :
- getMembers() :
- getMembersAsync() :
- getPaginator() : mixed
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getThreatIntelSet() :
- getThreatIntelSetAsync() :
- getUsageStatistics() :
- getUsageStatisticsAsync() :
- getWaiter() : mixed
- inviteMembers() :
- inviteMembersAsync() :
- listDetectors() :
- listDetectorsAsync() :
- listFilters() :
- listFiltersAsync() :
- listFindings() :
- listFindingsAsync() :
- listInvitations() :
- listInvitationsAsync() :
- listIPSets() :
- listIPSetsAsync() :
- listMembers() :
- listMembersAsync() :
- listOrganizationAdminAccounts() :
- listOrganizationAdminAccountsAsync() :
- listPublishingDestinations() :
- listPublishingDestinationsAsync() :
- listTagsForResource() :
- listTagsForResourceAsync() :
- listThreatIntelSets() :
- listThreatIntelSetsAsync() :
- startMonitoringMembers() :
- startMonitoringMembersAsync() :
- stopMonitoringMembers() :
- stopMonitoringMembersAsync() :
- tagResource() :
- tagResourceAsync() :
- unarchiveFindings() :
- unarchiveFindingsAsync() :
- untagResource() :
- untagResourceAsync() :
- updateDetector() :
- updateDetectorAsync() :
- updateFilter() :
- updateFilterAsync() :
- updateFindingsFeedback() :
- updateFindingsFeedbackAsync() :
- updateIPSet() :
- updateIPSetAsync() :
- updateMemberDetectors() :
- updateMemberDetectorsAsync() :
- updateOrganizationConfiguration() :
- updateOrganizationConfigurationAsync() :
- updatePublishingDestination() :
- updatePublishingDestinationAsync() :
- updateThreatIntelSet() :
- updateThreatIntelSetAsync() :
- waitUntil() : mixed
- addEndpointDiscoveryMiddleware() : mixed
- addEndpointParameterMiddleware() : mixed
- addInvocationId() : mixed
- addSignatureMiddleware() : mixed
- addStreamRequestPayload() : mixed
- loadAliases() : mixed
- parseClass() : array<string|int, mixed>
- Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
Properties
$aliases
private
array<string|int, mixed>
$aliases
$api
private
Service
$api
$config
private
array<string|int, mixed>
$config
$credentialProvider
private
callable
$credentialProvider
$defaultRequestOptions
private
array<string|int, mixed>
$defaultRequestOptions
$endpoint
private
string
$endpoint
$handlerList
private
HandlerList
$handlerList
$region
private
string
$region
$signatureProvider
private
callable
$signatureProvider
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed>
Return values
mixed —__construct()
The client constructor accepts the following options:
public
__construct(array<string|int, mixed> $args) : mixed
- api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
- credentials:
(Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies
the credentials used to sign requests. Provide an
Aws\Credentials\CredentialsInterface object, an associative array of
"key", "secret", and an optional "token" key,
falseto use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment. - csm:
(Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies
the credentials used to sign requests. Provide an
Aws\ClientSideMonitoring\ConfigurationInterface object, a callable
configuration provider used to create client-side monitoring configuration,
falseto disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project - debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
- stats: (bool|array) Set to true to gather transfer statistics on
requests sent. Alternatively, you can provide an associative array with
the following keys: retries: (bool) Set to false to disable reporting
on retries attempted; http: (bool) Set to true to enable collecting
statistics from lower level HTTP adapters (e.g., values returned in
GuzzleHttp\TransferStats). HTTP handlers must support an
http_stats_receiveroption for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds. - disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
- endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
- endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
- endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
- handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
- http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
- http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
- idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
- profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
- region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
- retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
- scheme: (string, default=string(5) "https") URI scheme to use when
connecting connect. The SDK will utilize "https" endpoints (i.e.,
utilize SSL/TLS connections) by default. You can attempt to connect to
a service over an unencrypted "http" endpoint by setting
schemeto "http". - signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
- signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
- use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
- validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
- version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —acceptInvitation()
public
acceptInvitation(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—acceptInvitationAsync()
public
acceptInvitationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—archiveFindings()
public
archiveFindings(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—archiveFindingsAsync()
public
archiveFindingsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createDetector()
public
createDetector(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createDetectorAsync()
public
createDetectorAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createFilter()
public
createFilter(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createFilterAsync()
public
createFilterAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createIPSet()
public
createIPSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createIPSetAsync()
public
createIPSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createMembers()
public
createMembers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createMembersAsync()
public
createMembersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createPublishingDestination()
public
createPublishingDestination(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createPublishingDestinationAsync()
public
createPublishingDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createSampleFindings()
public
createSampleFindings(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createSampleFindingsAsync()
public
createSampleFindingsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createThreatIntelSet()
public
createThreatIntelSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createThreatIntelSetAsync()
public
createThreatIntelSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—declineInvitations()
public
declineInvitations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—declineInvitationsAsync()
public
declineInvitationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteDetector()
public
deleteDetector(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteDetectorAsync()
public
deleteDetectorAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteFilter()
public
deleteFilter(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteFilterAsync()
public
deleteFilterAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteInvitations()
public
deleteInvitations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteInvitationsAsync()
public
deleteInvitationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteIPSet()
public
deleteIPSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteIPSetAsync()
public
deleteIPSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteMembers()
public
deleteMembers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteMembersAsync()
public
deleteMembersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deletePublishingDestination()
public
deletePublishingDestination(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deletePublishingDestinationAsync()
public
deletePublishingDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteThreatIntelSet()
public
deleteThreatIntelSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteThreatIntelSetAsync()
public
deleteThreatIntelSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeOrganizationConfiguration()
public
describeOrganizationConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeOrganizationConfigurationAsync()
public
describeOrganizationConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describePublishingDestination()
public
describePublishingDestination(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describePublishingDestinationAsync()
public
describePublishingDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disableOrganizationAdminAccount()
public
disableOrganizationAdminAccount(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disableOrganizationAdminAccountAsync()
public
disableOrganizationAdminAccountAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateFromMasterAccount()
public
disassociateFromMasterAccount(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateFromMasterAccountAsync()
public
disassociateFromMasterAccountAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateMembers()
public
disassociateMembers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateMembersAsync()
public
disassociateMembersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—enableOrganizationAdminAccount()
public
enableOrganizationAdminAccount(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—enableOrganizationAdminAccountAsync()
public
enableOrganizationAdminAccountAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
static —getApi()
public
abstract getApi() : Service
Return values
Service —getArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterface —getConfig()
Get a client configuration value.
public
getConfig([mixed $option = null ]) : mixed|null
Parameters
- $option : mixed = null
-
The option to retrieve. Pass null to retrieve all options.
Return values
mixed|null —getCredentials()
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method on the returned promise.
Return values
PromiseInterface —getDetector()
public
getDetector(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getDetectorAsync()
public
getDetectorAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterface —getFilter()
public
getFilter(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getFilterAsync()
public
getFilterAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getFindings()
public
getFindings(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getFindingsAsync()
public
getFindingsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getFindingsStatistics()
public
getFindingsStatistics(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getFindingsStatisticsAsync()
public
getFindingsStatisticsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Return values
HandlerList —getInvitationsCount()
public
getInvitationsCount(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getInvitationsCountAsync()
public
getInvitationsCountAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIPSet()
public
getIPSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIPSetAsync()
public
getIPSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —getMasterAccount()
public
getMasterAccount(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMasterAccountAsync()
public
getMasterAccountAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMemberDetectors()
public
getMemberDetectors(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMemberDetectorsAsync()
public
getMemberDetectorsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMembers()
public
getMembers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMembersAsync()
public
getMembersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
string —getSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callable —getThreatIntelSet()
public
getThreatIntelSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getThreatIntelSetAsync()
public
getThreatIntelSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUsageStatistics()
public
getUsageStatistics(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUsageStatisticsAsync()
public
getUsageStatisticsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —inviteMembers()
public
inviteMembers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—inviteMembersAsync()
public
inviteMembersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listDetectors()
public
listDetectors(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listDetectorsAsync()
public
listDetectorsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listFilters()
public
listFilters(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listFiltersAsync()
public
listFiltersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listFindings()
public
listFindings(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listFindingsAsync()
public
listFindingsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listInvitations()
public
listInvitations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listInvitationsAsync()
public
listInvitationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listIPSets()
public
listIPSets(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listIPSetsAsync()
public
listIPSetsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listMembers()
public
listMembers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listMembersAsync()
public
listMembersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listOrganizationAdminAccounts()
public
listOrganizationAdminAccounts(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listOrganizationAdminAccountsAsync()
public
listOrganizationAdminAccountsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPublishingDestinations()
public
listPublishingDestinations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPublishingDestinationsAsync()
public
listPublishingDestinationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listThreatIntelSets()
public
listThreatIntelSets(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listThreatIntelSetsAsync()
public
listThreatIntelSetsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startMonitoringMembers()
public
startMonitoringMembers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startMonitoringMembersAsync()
public
startMonitoringMembersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—stopMonitoringMembers()
public
stopMonitoringMembers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—stopMonitoringMembersAsync()
public
stopMonitoringMembersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—tagResource()
public
tagResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—tagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—unarchiveFindings()
public
unarchiveFindings(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—unarchiveFindingsAsync()
public
unarchiveFindingsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—untagResource()
public
untagResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—untagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateDetector()
public
updateDetector(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateDetectorAsync()
public
updateDetectorAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateFilter()
public
updateFilter(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateFilterAsync()
public
updateFilterAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateFindingsFeedback()
public
updateFindingsFeedback(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateFindingsFeedbackAsync()
public
updateFindingsFeedbackAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateIPSet()
public
updateIPSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateIPSetAsync()
public
updateIPSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateMemberDetectors()
public
updateMemberDetectors(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateMemberDetectorsAsync()
public
updateMemberDetectorsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateOrganizationConfiguration()
public
updateOrganizationConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateOrganizationConfigurationAsync()
public
updateOrganizationConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePublishingDestination()
public
updatePublishingDestination(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updatePublishingDestinationAsync()
public
updatePublishingDestinationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateThreatIntelSet()
public
updateThreatIntelSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateThreatIntelSetAsync()
public
updateThreatIntelSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—waitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —addEndpointDiscoveryMiddleware()
private
addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
- $config : mixed
- $args : mixed
Return values
mixed —addEndpointParameterMiddleware()
private
addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —addInvocationId()
private
addInvocationId() : mixed
Return values
mixed —addSignatureMiddleware()
private
addSignatureMiddleware() : mixed
Return values
mixed —addStreamRequestPayload()
private
addStreamRequestPayload() : mixed
Return values
mixed —loadAliases()
private
loadAliases([mixed $file = null ]) : mixed
Parameters
- $file : mixed = null
Return values
mixed —parseClass()
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
private
parseClass() : array<string|int, mixed>