GuardDutyClient
extends AwsClient
in package
This client is used to interact with the Amazon GuardDuty service.
Supported API Versions
This class uses a service description model that is associated at
runtime based on the version
option given when constructing the
client. The version
option will determine which API operations,
waiters, and paginators are available for a client. Creating a command or a
specific API operation can be done using magic methods (e.g.,
$client->commandName(/** parameters */)
, or using the
$client->getCommand
method of the client.
- AcceptAdministratorInvitation
- AcceptInvitation
- ArchiveFindings
- CreateDetector
- CreateFilter
- CreateIPSet
- CreateMembers
- CreatePublishingDestination
- CreateSampleFindings
- CreateThreatIntelSet
- DeclineInvitations
- DeleteDetector
- DeleteFilter
- DeleteIPSet
- DeleteInvitations
- DeleteMembers
- DeletePublishingDestination
- DeleteThreatIntelSet
- DescribeMalwareScans
- DescribeOrganizationConfiguration
- DescribePublishingDestination
- DisableOrganizationAdminAccount
- DisassociateFromAdministratorAccount
- DisassociateFromMasterAccount
- DisassociateMembers
- EnableOrganizationAdminAccount
- GetAdministratorAccount
- GetCoverageStatistics
- GetDetector
- GetFilter
- GetFindings
- GetFindingsStatistics
- GetIPSet
- GetInvitationsCount
- GetMalwareScanSettings
- GetMasterAccount
- GetMemberDetectors
- GetMembers
- GetOrganizationStatistics
- GetRemainingFreeTrialDays
- GetThreatIntelSet
- GetUsageStatistics
- InviteMembers
- ListCoverage
- ListDetectors
- ListFilters
- ListFindings
- ListIPSets
- ListInvitations
- ListMembers
- ListOrganizationAdminAccounts
- ListPublishingDestinations
- ListTagsForResource
- ListThreatIntelSets
- StartMalwareScan
- StartMonitoringMembers
- StopMonitoringMembers
- TagResource
- UnarchiveFindings
- UntagResource
- UpdateDetector
- UpdateFilter
- UpdateFindingsFeedback
- UpdateIPSet
- UpdateMalwareScanSettings
- UpdateMemberDetectors
- UpdateOrganizationConfiguration
- UpdatePublishingDestination
- UpdateThreatIntelSet
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- acceptAdministratorInvitation() : Result
- acceptAdministratorInvitationAsync() : Promise
- acceptInvitation() : Result
- acceptInvitationAsync() : Promise
- archiveFindings() : Result
- archiveFindingsAsync() : Promise
- createDetector() : Result
- createDetectorAsync() : Promise
- createFilter() : Result
- createFilterAsync() : Promise
- createIPSet() : Result
- createIPSetAsync() : Promise
- createMembers() : Result
- createMembersAsync() : Promise
- createPublishingDestination() : Result
- createPublishingDestinationAsync() : Promise
- createSampleFindings() : Result
- createSampleFindingsAsync() : Promise
- createThreatIntelSet() : Result
- createThreatIntelSetAsync() : Promise
- declineInvitations() : Result
- declineInvitationsAsync() : Promise
- deleteDetector() : Result
- deleteDetectorAsync() : Promise
- deleteFilter() : Result
- deleteFilterAsync() : Promise
- deleteInvitations() : Result
- deleteInvitationsAsync() : Promise
- deleteIPSet() : Result
- deleteIPSetAsync() : Promise
- deleteMembers() : Result
- deleteMembersAsync() : Promise
- deletePublishingDestination() : Result
- deletePublishingDestinationAsync() : Promise
- deleteThreatIntelSet() : Result
- deleteThreatIntelSetAsync() : Promise
- describeMalwareScans() : Result
- describeMalwareScansAsync() : Promise
- describeOrganizationConfiguration() : Result
- describeOrganizationConfigurationAsync() : Promise
- describePublishingDestination() : Result
- describePublishingDestinationAsync() : Promise
- disableOrganizationAdminAccount() : Result
- disableOrganizationAdminAccountAsync() : Promise
- disassociateFromAdministratorAccount() : Result
- disassociateFromAdministratorAccountAsync() : Promise
- disassociateFromMasterAccount() : Result
- disassociateFromMasterAccountAsync() : Promise
- disassociateMembers() : Result
- disassociateMembersAsync() : Promise
- emitDeprecationWarning() : mixed
- enableOrganizationAdminAccount() : Result
- enableOrganizationAdminAccountAsync() : Promise
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getAdministratorAccount() : Result
- getAdministratorAccountAsync() : Promise
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getClientBuiltIns() : array<string|int, mixed>
- Provides the set of built-in keys and values used for endpoint resolution
- getClientContextParams() : array<string|int, mixed>
- Provides the set of service context parameter key-value pairs used for endpoint resolution.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCoverageStatistics() : Result
- getCoverageStatisticsAsync() : Promise
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getDetector() : Result
- getDetectorAsync() : Promise
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getEndpointProvider() : mixed
- getEndpointProviderArgs() : array<string|int, mixed>
- Retrieves arguments to be used in endpoint resolution.
- getFilter() : Result
- getFilterAsync() : Promise
- getFindings() : Result
- getFindingsAsync() : Promise
- getFindingsStatistics() : Result
- getFindingsStatisticsAsync() : Promise
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getInvitationsCount() : Result
- getInvitationsCountAsync() : Promise
- getIPSet() : Result
- getIPSetAsync() : Promise
- getIterator() : mixed
- getMalwareScanSettings() : Result
- getMalwareScanSettingsAsync() : Promise
- getMasterAccount() : Result
- getMasterAccountAsync() : Promise
- getMemberDetectors() : Result
- getMemberDetectorsAsync() : Promise
- getMembers() : Result
- getMembersAsync() : Promise
- getOrganizationStatistics() : Result
- getOrganizationStatisticsAsync() : Promise
- getPaginator() : mixed
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getRemainingFreeTrialDays() : Result
- getRemainingFreeTrialDaysAsync() : Promise
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getThreatIntelSet() : Result
- getThreatIntelSetAsync() : Promise
- getUsageStatistics() : Result
- getUsageStatisticsAsync() : Promise
- getWaiter() : mixed
- inviteMembers() : Result
- inviteMembersAsync() : Promise
- listCoverage() : Result
- listCoverageAsync() : Promise
- listDetectors() : Result
- listDetectorsAsync() : Promise
- listFilters() : Result
- listFiltersAsync() : Promise
- listFindings() : Result
- listFindingsAsync() : Promise
- listInvitations() : Result
- listInvitationsAsync() : Promise
- listIPSets() : Result
- listIPSetsAsync() : Promise
- listMembers() : Result
- listMembersAsync() : Promise
- listOrganizationAdminAccounts() : Result
- listOrganizationAdminAccountsAsync() : Promise
- listPublishingDestinations() : Result
- listPublishingDestinationsAsync() : Promise
- listTagsForResource() : Result
- listTagsForResourceAsync() : Promise
- listThreatIntelSets() : Result
- listThreatIntelSetsAsync() : Promise
- startMalwareScan() : Result
- startMalwareScanAsync() : Promise
- startMonitoringMembers() : Result
- startMonitoringMembersAsync() : Promise
- stopMonitoringMembers() : Result
- stopMonitoringMembersAsync() : Promise
- tagResource() : Result
- tagResourceAsync() : Promise
- unarchiveFindings() : Result
- unarchiveFindingsAsync() : Promise
- untagResource() : Result
- untagResourceAsync() : Promise
- updateDetector() : Result
- updateDetectorAsync() : Promise
- updateFilter() : Result
- updateFilterAsync() : Promise
- updateFindingsFeedback() : Result
- updateFindingsFeedbackAsync() : Promise
- updateIPSet() : Result
- updateIPSetAsync() : Promise
- updateMalwareScanSettings() : Result
- updateMalwareScanSettingsAsync() : Promise
- updateMemberDetectors() : Result
- updateMemberDetectorsAsync() : Promise
- updateOrganizationConfiguration() : Result
- updateOrganizationConfigurationAsync() : Promise
- updatePublishingDestination() : Result
- updatePublishingDestinationAsync() : Promise
- updateThreatIntelSet() : Result
- updateThreatIntelSetAsync() : Promise
- waitUntil() : mixed
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, 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,
false
to 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. - token:
(Aws\Token\TokenInterface|array|bool|callable) Specifies
the token used to authorize requests. Provide an
Aws\Token\TokenInterface object, an associative array of
"token" and an optional "expires" key,
false
to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one 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,
false
to 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_receiver
option 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
scheme
to "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).
- ua_append: (string, array) To pass custom user agent parameters.
- app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
__sleep()
public
__sleep() : mixed
acceptAdministratorInvitation()
public
acceptAdministratorInvitation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultacceptAdministratorInvitationAsync()
public
acceptAdministratorInvitationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseacceptInvitation()
public
acceptInvitation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultacceptInvitationAsync()
public
acceptInvitationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisearchiveFindings()
public
archiveFindings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultarchiveFindingsAsync()
public
archiveFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateDetector()
public
createDetector(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateDetectorAsync()
public
createDetectorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateFilter()
public
createFilter(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateFilterAsync()
public
createFilterAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateIPSet()
public
createIPSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateIPSetAsync()
public
createIPSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateMembers()
public
createMembers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateMembersAsync()
public
createMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePublishingDestination()
public
createPublishingDestination(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePublishingDestinationAsync()
public
createPublishingDestinationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateSampleFindings()
public
createSampleFindings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateSampleFindingsAsync()
public
createSampleFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateThreatIntelSet()
public
createThreatIntelSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateThreatIntelSetAsync()
public
createThreatIntelSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeclineInvitations()
public
declineInvitations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeclineInvitationsAsync()
public
declineInvitationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDetector()
public
deleteDetector(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDetectorAsync()
public
deleteDetectorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteFilter()
public
deleteFilter(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteFilterAsync()
public
deleteFilterAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteInvitations()
public
deleteInvitations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteInvitationsAsync()
public
deleteInvitationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteIPSet()
public
deleteIPSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteIPSetAsync()
public
deleteIPSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteMembers()
public
deleteMembers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteMembersAsync()
public
deleteMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePublishingDestination()
public
deletePublishingDestination(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePublishingDestinationAsync()
public
deletePublishingDestinationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteThreatIntelSet()
public
deleteThreatIntelSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteThreatIntelSetAsync()
public
deleteThreatIntelSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeMalwareScans()
public
describeMalwareScans(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeMalwareScansAsync()
public
describeMalwareScansAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeOrganizationConfiguration()
public
describeOrganizationConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeOrganizationConfigurationAsync()
public
describeOrganizationConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribePublishingDestination()
public
describePublishingDestination(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribePublishingDestinationAsync()
public
describePublishingDestinationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisableOrganizationAdminAccount()
public
disableOrganizationAdminAccount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisableOrganizationAdminAccountAsync()
public
disableOrganizationAdminAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateFromAdministratorAccount()
public
disassociateFromAdministratorAccount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateFromAdministratorAccountAsync()
public
disassociateFromAdministratorAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateFromMasterAccount()
public
disassociateFromMasterAccount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateFromMasterAccountAsync()
public
disassociateFromMasterAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateMembers()
public
disassociateMembers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateMembersAsync()
public
disassociateMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
enableOrganizationAdminAccount()
public
enableOrganizationAdminAccount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultenableOrganizationAdminAccountAsync()
public
enableOrganizationAdminAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
Promiseexecute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetAdministratorAccount()
public
getAdministratorAccount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAdministratorAccountAsync()
public
getAdministratorAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientBuiltIns()
Provides the set of built-in keys and values used for endpoint resolution
public
getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientContextParams()
Provides the set of service context parameter key-value pairs used for endpoint resolution.
public
getClientContextParams() : 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
CommandInterfacegetConfig()
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|nullgetCoverageStatistics()
public
getCoverageStatistics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCoverageStatisticsAsync()
public
getCoverageStatisticsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCredentials()
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
PromiseInterfacegetDetector()
public
getDetector(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDetectorAsync()
public
getDetectorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
public
getEndpointProvider() : mixed
getEndpointProviderArgs()
Retrieves arguments to be used in endpoint resolution.
public
getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>getFilter()
public
getFilter(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetFilterAsync()
public
getFilterAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetFindings()
public
getFindings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetFindingsAsync()
public
getFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetFindingsStatistics()
public
getFindingsStatistics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetFindingsStatisticsAsync()
public
getFindingsStatisticsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHandlerList()
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
HandlerListgetInvitationsCount()
public
getInvitationsCount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetInvitationsCountAsync()
public
getInvitationsCountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIPSet()
public
getIPSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetIPSetAsync()
public
getIPSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getMalwareScanSettings()
public
getMalwareScanSettings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMalwareScanSettingsAsync()
public
getMalwareScanSettingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetMasterAccount()
public
getMasterAccount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMasterAccountAsync()
public
getMasterAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetMemberDetectors()
public
getMemberDetectors(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMemberDetectorsAsync()
public
getMemberDetectorsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetMembers()
public
getMembers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMembersAsync()
public
getMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetOrganizationStatistics()
public
getOrganizationStatistics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetOrganizationStatisticsAsync()
public
getOrganizationStatisticsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetRemainingFreeTrialDays()
public
getRemainingFreeTrialDays(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRemainingFreeTrialDaysAsync()
public
getRemainingFreeTrialDaysAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetThreatIntelSet()
public
getThreatIntelSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetThreatIntelSetAsync()
public
getThreatIntelSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetUsageStatistics()
public
getUsageStatistics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetUsageStatisticsAsync()
public
getUsageStatisticsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
inviteMembers()
public
inviteMembers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultinviteMembersAsync()
public
inviteMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCoverage()
public
listCoverage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCoverageAsync()
public
listCoverageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDetectors()
public
listDetectors(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDetectorsAsync()
public
listDetectorsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistFilters()
public
listFilters(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistFiltersAsync()
public
listFiltersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistFindings()
public
listFindings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistFindingsAsync()
public
listFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistInvitations()
public
listInvitations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistInvitationsAsync()
public
listInvitationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistIPSets()
public
listIPSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistIPSetsAsync()
public
listIPSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistMembers()
public
listMembers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistMembersAsync()
public
listMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistOrganizationAdminAccounts()
public
listOrganizationAdminAccounts(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistOrganizationAdminAccountsAsync()
public
listOrganizationAdminAccountsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPublishingDestinations()
public
listPublishingDestinations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPublishingDestinationsAsync()
public
listPublishingDestinationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistThreatIntelSets()
public
listThreatIntelSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistThreatIntelSetsAsync()
public
listThreatIntelSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartMalwareScan()
public
startMalwareScan(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartMalwareScanAsync()
public
startMalwareScanAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartMonitoringMembers()
public
startMonitoringMembers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartMonitoringMembersAsync()
public
startMonitoringMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestopMonitoringMembers()
public
stopMonitoringMembers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstopMonitoringMembersAsync()
public
stopMonitoringMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseunarchiveFindings()
public
unarchiveFindings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultunarchiveFindingsAsync()
public
unarchiveFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDetector()
public
updateDetector(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDetectorAsync()
public
updateDetectorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateFilter()
public
updateFilter(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateFilterAsync()
public
updateFilterAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateFindingsFeedback()
public
updateFindingsFeedback(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateFindingsFeedbackAsync()
public
updateFindingsFeedbackAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateIPSet()
public
updateIPSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateIPSetAsync()
public
updateIPSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateMalwareScanSettings()
public
updateMalwareScanSettings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateMalwareScanSettingsAsync()
public
updateMalwareScanSettingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateMemberDetectors()
public
updateMemberDetectors(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateMemberDetectorsAsync()
public
updateMemberDetectorsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateOrganizationConfiguration()
public
updateOrganizationConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateOrganizationConfigurationAsync()
public
updateOrganizationConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdatePublishingDestination()
public
updatePublishingDestination(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdatePublishingDestinationAsync()
public
updatePublishingDestinationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateThreatIntelSet()
public
updateThreatIntelSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateThreatIntelSetAsync()
public
updateThreatIntelSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []