SDK for PHP 3.x

AuditManagerClient extends AwsClient
in package

This client is used to interact with the AWS Audit Manager 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
associateAssessmentReportEvidenceFolder()  : Result
associateAssessmentReportEvidenceFolderAsync()  : Promise
batchAssociateAssessmentReportEvidence()  : Result
batchAssociateAssessmentReportEvidenceAsync()  : Promise
batchCreateDelegationByAssessment()  : Result
batchCreateDelegationByAssessmentAsync()  : Promise
batchDeleteDelegationByAssessment()  : Result
batchDeleteDelegationByAssessmentAsync()  : Promise
batchDisassociateAssessmentReportEvidence()  : Result
batchDisassociateAssessmentReportEvidenceAsync()  : Promise
batchImportEvidenceToAssessmentControl()  : Result
batchImportEvidenceToAssessmentControlAsync()  : Promise
createAssessment()  : Result
createAssessmentAsync()  : Promise
createAssessmentFramework()  : Result
createAssessmentFrameworkAsync()  : Promise
createAssessmentReport()  : Result
createAssessmentReportAsync()  : Promise
createControl()  : Result
createControlAsync()  : Promise
deleteAssessment()  : Result
deleteAssessmentAsync()  : Promise
deleteAssessmentFramework()  : Result
deleteAssessmentFrameworkAsync()  : Promise
deleteAssessmentFrameworkShare()  : Result
deleteAssessmentFrameworkShareAsync()  : Promise
deleteAssessmentReport()  : Result
deleteAssessmentReportAsync()  : Promise
deleteControl()  : Result
deleteControlAsync()  : Promise
deregisterAccount()  : Result
deregisterAccountAsync()  : Promise
deregisterOrganizationAdminAccount()  : Result
deregisterOrganizationAdminAccountAsync()  : Promise
disassociateAssessmentReportEvidenceFolder()  : Result
disassociateAssessmentReportEvidenceFolderAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getAccountStatus()  : Result
getAccountStatusAsync()  : Promise
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getAssessment()  : Result
getAssessmentAsync()  : Promise
getAssessmentFramework()  : Result
getAssessmentFrameworkAsync()  : Promise
getAssessmentReportUrl()  : Result
getAssessmentReportUrlAsync()  : Promise
getChangeLogs()  : Result
getChangeLogsAsync()  : Promise
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.
getControl()  : Result
getControlAsync()  : Promise
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getDelegations()  : Result
getDelegationsAsync()  : 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.
getEvidence()  : Result
getEvidenceAsync()  : Promise
getEvidenceByEvidenceFolder()  : Result
getEvidenceByEvidenceFolderAsync()  : Promise
getEvidenceFileUploadUrl()  : Result
getEvidenceFileUploadUrlAsync()  : Promise
getEvidenceFolder()  : Result
getEvidenceFolderAsync()  : Promise
getEvidenceFoldersByAssessment()  : Result
getEvidenceFoldersByAssessmentAsync()  : Promise
getEvidenceFoldersByAssessmentControl()  : Result
getEvidenceFoldersByAssessmentControlAsync()  : Promise
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getInsights()  : Result
getInsightsAsync()  : Promise
getInsightsByAssessment()  : Result
getInsightsByAssessmentAsync()  : Promise
getIterator()  : mixed
getOrganizationAdminAccount()  : Result
getOrganizationAdminAccountAsync()  : Promise
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getServicesInScope()  : Result
getServicesInScopeAsync()  : Promise
getSettings()  : Result
getSettingsAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
listAssessmentControlInsightsByControlDomain()  : Result
listAssessmentControlInsightsByControlDomainAsync()  : Promise
listAssessmentFrameworks()  : Result
listAssessmentFrameworksAsync()  : Promise
listAssessmentFrameworkShareRequests()  : Result
listAssessmentFrameworkShareRequestsAsync()  : Promise
listAssessmentReports()  : Result
listAssessmentReportsAsync()  : Promise
listAssessments()  : Result
listAssessmentsAsync()  : Promise
listControlDomainInsights()  : Result
listControlDomainInsightsAsync()  : Promise
listControlDomainInsightsByAssessment()  : Result
listControlDomainInsightsByAssessmentAsync()  : Promise
listControlInsightsByControlDomain()  : Result
listControlInsightsByControlDomainAsync()  : Promise
listControls()  : Result
listControlsAsync()  : Promise
listKeywordsForDataSource()  : Result
listKeywordsForDataSourceAsync()  : Promise
listNotifications()  : Result
listNotificationsAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
registerAccount()  : Result
registerAccountAsync()  : Promise
registerOrganizationAdminAccount()  : Result
registerOrganizationAdminAccountAsync()  : Promise
startAssessmentFrameworkShare()  : Result
startAssessmentFrameworkShareAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateAssessment()  : Result
updateAssessmentAsync()  : Promise
updateAssessmentControl()  : Result
updateAssessmentControlAsync()  : Promise
updateAssessmentControlSetStatus()  : Result
updateAssessmentControlSetStatusAsync()  : Promise
updateAssessmentFramework()  : Result
updateAssessmentFrameworkAsync()  : Promise
updateAssessmentFrameworkShare()  : Result
updateAssessmentFrameworkShareAsync()  : Promise
updateAssessmentStatus()  : Result
updateAssessmentStatusAsync()  : Promise
updateControl()  : Result
updateControlAsync()  : Promise
updateSettings()  : Result
updateSettingsAsync()  : Promise
validateAssessmentReportIntegrity()  : Result
validateAssessmentReportIntegrityAsync()  : 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

associateAssessmentReportEvidenceFolder()

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

associateAssessmentReportEvidenceFolderAsync()

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

batchAssociateAssessmentReportEvidence()

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

batchAssociateAssessmentReportEvidenceAsync()

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

batchCreateDelegationByAssessment()

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

batchCreateDelegationByAssessmentAsync()

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

batchDeleteDelegationByAssessment()

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

batchDeleteDelegationByAssessmentAsync()

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

batchDisassociateAssessmentReportEvidence()

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

batchDisassociateAssessmentReportEvidenceAsync()

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

batchImportEvidenceToAssessmentControl()

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

batchImportEvidenceToAssessmentControlAsync()

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

createAssessment()

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

createAssessmentAsync()

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

createAssessmentFramework()

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

createAssessmentFrameworkAsync()

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

createAssessmentReport()

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

createAssessmentReportAsync()

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

createControl()

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

createControlAsync()

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

deleteAssessment()

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

deleteAssessmentAsync()

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

deleteAssessmentFramework()

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

deleteAssessmentFrameworkAsync()

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

deleteAssessmentFrameworkShare()

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

deleteAssessmentFrameworkShareAsync()

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

deleteAssessmentReport()

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

deleteAssessmentReportAsync()

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

deleteControl()

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

deleteControlAsync()

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

deregisterAccount()

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

deregisterAccountAsync()

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

deregisterOrganizationAdminAccount()

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

deregisterOrganizationAdminAccountAsync()

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

disassociateAssessmentReportEvidenceFolder()

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

disassociateAssessmentReportEvidenceFolderAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

getAccountStatus()

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

getAccountStatusAsync()

public getAccountStatusAsync(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>

getAssessment()

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

getAssessmentAsync()

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

getAssessmentFramework()

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

getAssessmentFrameworkAsync()

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

getAssessmentReportUrl()

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

getAssessmentReportUrlAsync()

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

getChangeLogs()

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

getChangeLogsAsync()

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

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

getControl()

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

getControlAsync()

public getControlAsync(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

getDelegations()

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

getDelegationsAsync()

public getDelegationsAsync(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>

getEvidence()

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

getEvidenceAsync()

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

getEvidenceByEvidenceFolder()

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

getEvidenceByEvidenceFolderAsync()

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

getEvidenceFileUploadUrl()

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

getEvidenceFileUploadUrlAsync()

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

getEvidenceFolder()

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

getEvidenceFolderAsync()

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

getEvidenceFoldersByAssessment()

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

getEvidenceFoldersByAssessmentAsync()

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

getEvidenceFoldersByAssessmentControl()

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

getEvidenceFoldersByAssessmentControlAsync()

public getEvidenceFoldersByAssessmentControlAsync(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

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

getInsightsByAssessment()

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

getInsightsByAssessmentAsync()

public getInsightsByAssessmentAsync(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> = []

getOrganizationAdminAccount()

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

getOrganizationAdminAccountAsync()

public getOrganizationAdminAccountAsync(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

getServicesInScope()

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

getServicesInScopeAsync()

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

getSettings()

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

getSettingsAsync()

public getSettingsAsync(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> = []

listAssessmentControlInsightsByControlDomain()

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

listAssessmentControlInsightsByControlDomainAsync()

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

listAssessmentFrameworks()

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

listAssessmentFrameworksAsync()

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

listAssessmentFrameworkShareRequests()

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

listAssessmentFrameworkShareRequestsAsync()

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

listAssessmentReports()

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

listAssessmentReportsAsync()

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

listAssessments()

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

listAssessmentsAsync()

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

listControlDomainInsights()

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

listControlDomainInsightsAsync()

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

listControlDomainInsightsByAssessment()

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

listControlDomainInsightsByAssessmentAsync()

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

listControlInsightsByControlDomain()

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

listControlInsightsByControlDomainAsync()

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

listControls()

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

listControlsAsync()

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

listKeywordsForDataSource()

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

listKeywordsForDataSourceAsync()

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

listNotifications()

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

listNotificationsAsync()

public listNotificationsAsync(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

registerAccount()

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

registerAccountAsync()

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

registerOrganizationAdminAccount()

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

registerOrganizationAdminAccountAsync()

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

startAssessmentFrameworkShare()

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

startAssessmentFrameworkShareAsync()

public startAssessmentFrameworkShareAsync(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

updateAssessment()

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

updateAssessmentAsync()

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

updateAssessmentControl()

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

updateAssessmentControlAsync()

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

updateAssessmentControlSetStatus()

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

updateAssessmentControlSetStatusAsync()

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

updateAssessmentFramework()

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

updateAssessmentFrameworkAsync()

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

updateAssessmentFrameworkShare()

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

updateAssessmentFrameworkShareAsync()

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

updateAssessmentStatus()

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

updateAssessmentStatusAsync()

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

updateControl()

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

updateControlAsync()

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

updateSettings()

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

updateSettingsAsync()

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

validateAssessmentReportIntegrity()

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

validateAssessmentReportIntegrityAsync()

public validateAssessmentReportIntegrityAsync(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