SDK for PHP 3.x

SecurityHubClient extends AwsClient
in package

This client is used to interact with the AWS SecurityHub 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.

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
batchDeleteAutomationRules()  : Result
batchDeleteAutomationRulesAsync()  : Promise
batchDisableStandards()  : Result
batchDisableStandardsAsync()  : Promise
batchEnableStandards()  : Result
batchEnableStandardsAsync()  : Promise
batchGetAutomationRules()  : Result
batchGetAutomationRulesAsync()  : Promise
batchGetConfigurationPolicyAssociations()  : Result
batchGetConfigurationPolicyAssociationsAsync()  : Promise
batchGetSecurityControls()  : Result
batchGetSecurityControlsAsync()  : Promise
batchGetStandardsControlAssociations()  : Result
batchGetStandardsControlAssociationsAsync()  : Promise
batchImportFindings()  : Result
batchImportFindingsAsync()  : Promise
batchUpdateAutomationRules()  : Result
batchUpdateAutomationRulesAsync()  : Promise
batchUpdateFindings()  : Result
batchUpdateFindingsAsync()  : Promise
batchUpdateStandardsControlAssociations()  : Result
batchUpdateStandardsControlAssociationsAsync()  : Promise
createActionTarget()  : Result
createActionTargetAsync()  : Promise
createAutomationRule()  : Result
createAutomationRuleAsync()  : Promise
createConfigurationPolicy()  : Result
createConfigurationPolicyAsync()  : Promise
createFindingAggregator()  : Result
createFindingAggregatorAsync()  : Promise
createInsight()  : Result
createInsightAsync()  : Promise
createMembers()  : Result
createMembersAsync()  : Promise
declineInvitations()  : Result
declineInvitationsAsync()  : Promise
deleteActionTarget()  : Result
deleteActionTargetAsync()  : Promise
deleteConfigurationPolicy()  : Result
deleteConfigurationPolicyAsync()  : Promise
deleteFindingAggregator()  : Result
deleteFindingAggregatorAsync()  : Promise
deleteInsight()  : Result
deleteInsightAsync()  : Promise
deleteInvitations()  : Result
deleteInvitationsAsync()  : Promise
deleteMembers()  : Result
deleteMembersAsync()  : Promise
describeActionTargets()  : Result
describeActionTargetsAsync()  : Promise
describeHub()  : Result
describeHubAsync()  : Promise
describeOrganizationConfiguration()  : Result
describeOrganizationConfigurationAsync()  : Promise
describeProducts()  : Result
describeProductsAsync()  : Promise
describeStandards()  : Result
describeStandardsAsync()  : Promise
describeStandardsControls()  : Result
describeStandardsControlsAsync()  : Promise
disableImportFindingsForProduct()  : Result
disableImportFindingsForProductAsync()  : Promise
disableOrganizationAdminAccount()  : Result
disableOrganizationAdminAccountAsync()  : Promise
disableSecurityHub()  : Result
disableSecurityHubAsync()  : Promise
disassociateFromAdministratorAccount()  : Result
disassociateFromAdministratorAccountAsync()  : Promise
disassociateFromMasterAccount()  : Result
disassociateFromMasterAccountAsync()  : Promise
disassociateMembers()  : Result
disassociateMembersAsync()  : Promise
emitDeprecationWarning()  : mixed
enableImportFindingsForProduct()  : Result
enableImportFindingsForProductAsync()  : Promise
enableOrganizationAdminAccount()  : Result
enableOrganizationAdminAccountAsync()  : Promise
enableSecurityHub()  : Result
enableSecurityHubAsync()  : 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.
getConfigurationPolicy()  : Result
getConfigurationPolicyAssociation()  : Result
getConfigurationPolicyAssociationAsync()  : Promise
getConfigurationPolicyAsync()  : Promise
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEnabledStandards()  : Result
getEnabledStandardsAsync()  : 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.
getFindingAggregator()  : Result
getFindingAggregatorAsync()  : Promise
getFindingHistory()  : Result
getFindingHistoryAsync()  : Promise
getFindings()  : Result
getFindingsAsync()  : Promise
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getInsightResults()  : Result
getInsightResultsAsync()  : Promise
getInsights()  : Result
getInsightsAsync()  : Promise
getInvitationsCount()  : Result
getInvitationsCountAsync()  : Promise
getIterator()  : mixed
getMasterAccount()  : Result
getMasterAccountAsync()  : Promise
getMembers()  : Result
getMembersAsync()  : Promise
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSecurityControlDefinition()  : Result
getSecurityControlDefinitionAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
inviteMembers()  : Result
inviteMembersAsync()  : Promise
listAutomationRules()  : Result
listAutomationRulesAsync()  : Promise
listConfigurationPolicies()  : Result
listConfigurationPoliciesAsync()  : Promise
listConfigurationPolicyAssociations()  : Result
listConfigurationPolicyAssociationsAsync()  : Promise
listEnabledProductsForImport()  : Result
listEnabledProductsForImportAsync()  : Promise
listFindingAggregators()  : Result
listFindingAggregatorsAsync()  : Promise
listInvitations()  : Result
listInvitationsAsync()  : Promise
listMembers()  : Result
listMembersAsync()  : Promise
listOrganizationAdminAccounts()  : Result
listOrganizationAdminAccountsAsync()  : Promise
listSecurityControlDefinitions()  : Result
listSecurityControlDefinitionsAsync()  : Promise
listStandardsControlAssociations()  : Result
listStandardsControlAssociationsAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
startConfigurationPolicyAssociation()  : Result
startConfigurationPolicyAssociationAsync()  : Promise
startConfigurationPolicyDisassociation()  : Result
startConfigurationPolicyDisassociationAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateActionTarget()  : Result
updateActionTargetAsync()  : Promise
updateConfigurationPolicy()  : Result
updateConfigurationPolicyAsync()  : Promise
updateFindingAggregator()  : Result
updateFindingAggregatorAsync()  : Promise
updateFindings()  : Result
updateFindingsAsync()  : Promise
updateInsight()  : Result
updateInsightAsync()  : Promise
updateOrganizationConfiguration()  : Result
updateOrganizationConfigurationAsync()  : Promise
updateSecurityControl()  : Result
updateSecurityControlAsync()  : Promise
updateSecurityHubConfiguration()  : Result
updateSecurityHubConfigurationAsync()  : Promise
updateStandardsControl()  : Result
updateStandardsControlAsync()  : 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
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

__sleep()

public __sleep() : mixed

acceptAdministratorInvitation()

public acceptAdministratorInvitation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

acceptAdministratorInvitationAsync()

public acceptAdministratorInvitationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

acceptInvitation()

public acceptInvitation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

acceptInvitationAsync()

public acceptInvitationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchDeleteAutomationRules()

public batchDeleteAutomationRules(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchDeleteAutomationRulesAsync()

public batchDeleteAutomationRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchDisableStandards()

public batchDisableStandards(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchDisableStandardsAsync()

public batchDisableStandardsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchEnableStandards()

public batchEnableStandards(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchEnableStandardsAsync()

public batchEnableStandardsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchGetAutomationRules()

public batchGetAutomationRules(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchGetAutomationRulesAsync()

public batchGetAutomationRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchGetConfigurationPolicyAssociations()

public batchGetConfigurationPolicyAssociations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchGetConfigurationPolicyAssociationsAsync()

public batchGetConfigurationPolicyAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchGetSecurityControls()

public batchGetSecurityControls(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchGetSecurityControlsAsync()

public batchGetSecurityControlsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchGetStandardsControlAssociations()

public batchGetStandardsControlAssociations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchGetStandardsControlAssociationsAsync()

public batchGetStandardsControlAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchImportFindings()

public batchImportFindings(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchImportFindingsAsync()

public batchImportFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchUpdateAutomationRules()

public batchUpdateAutomationRules(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchUpdateAutomationRulesAsync()

public batchUpdateAutomationRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchUpdateFindings()

public batchUpdateFindings(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchUpdateFindingsAsync()

public batchUpdateFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

batchUpdateStandardsControlAssociations()

public batchUpdateStandardsControlAssociations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

batchUpdateStandardsControlAssociationsAsync()

public batchUpdateStandardsControlAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createActionTarget()

public createActionTarget(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createActionTargetAsync()

public createActionTargetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createAutomationRule()

public createAutomationRule(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createAutomationRuleAsync()

public createAutomationRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createConfigurationPolicy()

public createConfigurationPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createConfigurationPolicyAsync()

public createConfigurationPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createFindingAggregator()

public createFindingAggregator(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createFindingAggregatorAsync()

public createFindingAggregatorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createInsight()

public createInsight(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createInsightAsync()

public createInsightAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createMembers()

public createMembers(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createMembersAsync()

public createMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

declineInvitations()

public declineInvitations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

declineInvitationsAsync()

public declineInvitationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteActionTarget()

public deleteActionTarget(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteActionTargetAsync()

public deleteActionTargetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteConfigurationPolicy()

public deleteConfigurationPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteConfigurationPolicyAsync()

public deleteConfigurationPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteFindingAggregator()

public deleteFindingAggregator(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteFindingAggregatorAsync()

public deleteFindingAggregatorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteInsight()

public deleteInsight(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteInsightAsync()

public deleteInsightAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteInvitations()

public deleteInvitations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteInvitationsAsync()

public deleteInvitationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteMembers()

public deleteMembers(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteMembersAsync()

public deleteMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describeActionTargets()

public describeActionTargets(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describeActionTargetsAsync()

public describeActionTargetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describeHub()

public describeHub(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describeHubAsync()

public describeHubAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describeOrganizationConfiguration()

public describeOrganizationConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describeOrganizationConfigurationAsync()

public describeOrganizationConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describeProducts()

public describeProducts(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describeProductsAsync()

public describeProductsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describeStandards()

public describeStandards(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describeStandardsAsync()

public describeStandardsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describeStandardsControls()

public describeStandardsControls(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describeStandardsControlsAsync()

public describeStandardsControlsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

disableImportFindingsForProduct()

public disableImportFindingsForProduct(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

disableImportFindingsForProductAsync()

public disableImportFindingsForProductAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

disableOrganizationAdminAccount()

public disableOrganizationAdminAccount(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

disableOrganizationAdminAccountAsync()

public disableOrganizationAdminAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

disableSecurityHub()

public disableSecurityHub(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

disableSecurityHubAsync()

public disableSecurityHubAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

disassociateFromAdministratorAccount()

public disassociateFromAdministratorAccount(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

disassociateFromAdministratorAccountAsync()

public disassociateFromAdministratorAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

disassociateFromMasterAccount()

public disassociateFromMasterAccount(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

disassociateFromMasterAccountAsync()

public disassociateFromMasterAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

disassociateMembers()

public disassociateMembers(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

disassociateMembersAsync()

public disassociateMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

enableImportFindingsForProduct()

public enableImportFindingsForProduct(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

enableImportFindingsForProductAsync()

public enableImportFindingsForProductAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

enableOrganizationAdminAccount()

public enableOrganizationAdminAccount(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

enableOrganizationAdminAccountAsync()

public enableOrganizationAdminAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

enableSecurityHub()

public enableSecurityHub(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

enableSecurityHubAsync()

public enableSecurityHubAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static

getAdministratorAccount()

public getAdministratorAccount(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAdministratorAccountAsync()

public getAdministratorAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

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>

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
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

getConfigurationPolicy()

public getConfigurationPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getConfigurationPolicyAssociation()

public getConfigurationPolicyAssociation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getConfigurationPolicyAssociationAsync()

public getConfigurationPolicyAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getConfigurationPolicyAsync()

public getConfigurationPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

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

getEnabledStandards()

public getEnabledStandards(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getEnabledStandardsAsync()

public getEnabledStandardsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

public getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFindingAggregator()

public getFindingAggregator(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getFindingAggregatorAsync()

public getFindingAggregatorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getFindingHistory()

public getFindingHistory(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getFindingHistoryAsync()

public getFindingHistoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getFindings()

public getFindings(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getFindingsAsync()

public getFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

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

getInsightResults()

public getInsightResults(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getInsightResultsAsync()

public getInsightResultsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getInsights()

public getInsights(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getInsightsAsync()

public getInsightsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getInvitationsCount()

public getInvitationsCount(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getInvitationsCountAsync()

public getInvitationsCountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

getMasterAccount()

public getMasterAccount(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getMasterAccountAsync()

public getMasterAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getMembers()

public getMembers(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getMembersAsync()

public getMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getPaginator()

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
string

getSecurityControlDefinition()

public getSecurityControlDefinition(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getSecurityControlDefinitionAsync()

public getSecurityControlDefinitionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getWaiter()

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
Result

inviteMembersAsync()

public inviteMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listAutomationRules()

public listAutomationRules(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listAutomationRulesAsync()

public listAutomationRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listConfigurationPolicies()

public listConfigurationPolicies(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listConfigurationPoliciesAsync()

public listConfigurationPoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listConfigurationPolicyAssociations()

public listConfigurationPolicyAssociations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listConfigurationPolicyAssociationsAsync()

public listConfigurationPolicyAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listEnabledProductsForImport()

public listEnabledProductsForImport(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listEnabledProductsForImportAsync()

public listEnabledProductsForImportAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listFindingAggregators()

public listFindingAggregators(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listFindingAggregatorsAsync()

public listFindingAggregatorsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listInvitations()

public listInvitations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listInvitationsAsync()

public listInvitationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listMembers()

public listMembers(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listMembersAsync()

public listMembersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listOrganizationAdminAccounts()

public listOrganizationAdminAccounts(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listOrganizationAdminAccountsAsync()

public listOrganizationAdminAccountsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listSecurityControlDefinitions()

public listSecurityControlDefinitions(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listSecurityControlDefinitionsAsync()

public listSecurityControlDefinitionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listStandardsControlAssociations()

public listStandardsControlAssociations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listStandardsControlAssociationsAsync()

public listStandardsControlAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listTagsForResource()

public listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listTagsForResourceAsync()

public listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

startConfigurationPolicyAssociation()

public startConfigurationPolicyAssociation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

startConfigurationPolicyAssociationAsync()

public startConfigurationPolicyAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

startConfigurationPolicyDisassociation()

public startConfigurationPolicyDisassociation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

startConfigurationPolicyDisassociationAsync()

public startConfigurationPolicyDisassociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

tagResource()

public tagResource(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

tagResourceAsync()

public tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

untagResource()

public untagResource(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

untagResourceAsync()

public untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateActionTarget()

public updateActionTarget(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateActionTargetAsync()

public updateActionTargetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateConfigurationPolicy()

public updateConfigurationPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateConfigurationPolicyAsync()

public updateConfigurationPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateFindingAggregator()

public updateFindingAggregator(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateFindingAggregatorAsync()

public updateFindingAggregatorAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateFindings()

public updateFindings(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateFindingsAsync()

public updateFindingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateInsight()

public updateInsight(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateInsightAsync()

public updateInsightAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateOrganizationConfiguration()

public updateOrganizationConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateOrganizationConfigurationAsync()

public updateOrganizationConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateSecurityControl()

public updateSecurityControl(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateSecurityControlAsync()

public updateSecurityControlAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateSecurityHubConfiguration()

public updateSecurityHubConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateSecurityHubConfigurationAsync()

public updateSecurityHubConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateStandardsControl()

public updateStandardsControl(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateStandardsControlAsync()

public updateStandardsControlAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
On this page