BatchGetUserAccessTasks

$result = $client->batchGetUserAccessTasks([/* ... */]);
$promise = $client->batchGetUserAccessTasksAsync([/* ... */]);

Gets user access details in a batch request.

This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.

Parameter Syntax

$result = $client->batchGetUserAccessTasks([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'taskIdList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'userAccessResultsList' => [
        [
            'app' => '<string>',
            'email' => '<string>',
            'resultStatus' => 'IN_PROGRESS|COMPLETED|FAILED|EXPIRED',
            'taskError' => [
                'errorCode' => '<string>',
                'errorMessage' => '<string>',
            ],
            'taskId' => '<string>',
            'tenantDisplayName' => '<string>',
            'tenantId' => '<string>',
            'userFirstName' => '<string>',
            'userFullName' => '<string>',
            'userId' => '<string>',
            'userLastName' => '<string>',
            'userStatus' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

ConnectAppAuthorization

$result = $client->connectAppAuthorization([/* ... */]);
$promise = $client->connectAppAuthorizationAsync([/* ... */]);

Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.

Parameter Syntax

$result = $client->connectAppAuthorization([
    'appAuthorizationIdentifier' => '<string>', // REQUIRED
    'appBundleIdentifier' => '<string>', // REQUIRED
    'authRequest' => [
        'code' => '<string>', // REQUIRED
        'redirectUri' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'appAuthorizationSummary' => [
        'app' => '<string>',
        'appAuthorizationArn' => '<string>',
        'appBundleArn' => '<string>',
        'status' => 'PendingConnect|Connected|ConnectionValidationFailed|TokenAutoRotationFailed',
        'tenant' => [
            'tenantDisplayName' => '<string>',
            'tenantIdentifier' => '<string>',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

CreateAppAuthorization

$result = $client->createAppAuthorization([/* ... */]);
$promise = $client->createAppAuthorizationAsync([/* ... */]);

Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.

Parameter Syntax

$result = $client->createAppAuthorization([
    'app' => '<string>', // REQUIRED
    'appBundleIdentifier' => '<string>', // REQUIRED
    'authType' => 'oauth2|apiKey', // REQUIRED
    'clientToken' => '<string>',
    'credential' => [ // REQUIRED
        'apiKeyCredential' => [
            'apiKey' => '<string>', // REQUIRED
        ],
        'oauth2Credential' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'tenant' => [ // REQUIRED
        'tenantDisplayName' => '<string>', // REQUIRED
        'tenantIdentifier' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'appAuthorization' => [
        'app' => '<string>',
        'appAuthorizationArn' => '<string>',
        'appBundleArn' => '<string>',
        'authType' => 'oauth2|apiKey',
        'authUrl' => '<string>',
        'createdAt' => <DateTime>,
        'persona' => 'admin|endUser',
        'status' => 'PendingConnect|Connected|ConnectionValidationFailed|TokenAutoRotationFailed',
        'tenant' => [
            'tenantDisplayName' => '<string>',
            'tenantIdentifier' => '<string>',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request rate exceeds the limit.

ConflictException:

The request has created a conflict. Check the request parameters and try again.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

CreateAppBundle

$result = $client->createAppBundle([/* ... */]);
$promise = $client->createAppBundleAsync([/* ... */]);

Creates an app bundle to collect data from an application using AppFabric.

Parameter Syntax

$result = $client->createAppBundle([
    'clientToken' => '<string>',
    'customerManagedKeyIdentifier' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appBundle' => [
        'arn' => '<string>',
        'customerManagedKeyArn' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request rate exceeds the limit.

ConflictException:

The request has created a conflict. Check the request parameters and try again.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

You are not authorized to perform this operation.

CreateIngestion

$result = $client->createIngestion([/* ... */]);
$promise = $client->createIngestionAsync([/* ... */]);

Creates a data ingestion for an application.

Parameter Syntax

$result = $client->createIngestion([
    'app' => '<string>', // REQUIRED
    'appBundleIdentifier' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'ingestionType' => 'auditLog', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'tenantId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ingestion' => [
        'app' => '<string>',
        'appBundleArn' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'ingestionType' => 'auditLog',
        'state' => 'enabled|disabled',
        'tenantId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request rate exceeds the limit.

ConflictException:

The request has created a conflict. Check the request parameters and try again.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

You are not authorized to perform this operation.

CreateIngestionDestination

$result = $client->createIngestionDestination([/* ... */]);
$promise = $client->createIngestionDestinationAsync([/* ... */]);

Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

Parameter Syntax

$result = $client->createIngestionDestination([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'destinationConfiguration' => [ // REQUIRED
        'auditLog' => [
            'destination' => [ // REQUIRED
                'firehoseStream' => [
                    'streamName' => '<string>', // REQUIRED
                ],
                's3Bucket' => [
                    'bucketName' => '<string>', // REQUIRED
                    'prefix' => '<string>',
                ],
            ],
        ],
    ],
    'ingestionIdentifier' => '<string>', // REQUIRED
    'processingConfiguration' => [ // REQUIRED
        'auditLog' => [
            'format' => 'json|parquet', // REQUIRED
            'schema' => 'ocsf|raw', // REQUIRED
        ],
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ingestionDestination' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'destinationConfiguration' => [
            'auditLog' => [
                'destination' => [
                    'firehoseStream' => [
                        'streamName' => '<string>',
                    ],
                    's3Bucket' => [
                        'bucketName' => '<string>',
                        'prefix' => '<string>',
                    ],
                ],
            ],
        ],
        'ingestionArn' => '<string>',
        'processingConfiguration' => [
            'auditLog' => [
                'format' => 'json|parquet',
                'schema' => 'ocsf|raw',
            ],
        ],
        'status' => 'Active|Failed',
        'statusReason' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request rate exceeds the limit.

ConflictException:

The request has created a conflict. Check the request parameters and try again.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

You are not authorized to perform this operation.

DeleteAppAuthorization

$result = $client->deleteAppAuthorization([/* ... */]);
$promise = $client->deleteAppAuthorizationAsync([/* ... */]);

Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.

Parameter Syntax

$result = $client->deleteAppAuthorization([
    'appAuthorizationIdentifier' => '<string>', // REQUIRED
    'appBundleIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

DeleteAppBundle

$result = $client->deleteAppBundle([/* ... */]);
$promise = $client->deleteAppBundleAsync([/* ... */]);

Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.

Parameter Syntax

$result = $client->deleteAppBundle([
    'appBundleIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ConflictException:

The request has created a conflict. Check the request parameters and try again.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

You are not authorized to perform this operation.

DeleteIngestion

$result = $client->deleteIngestion([/* ... */]);
$promise = $client->deleteIngestionAsync([/* ... */]);

Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.

Parameter Syntax

$result = $client->deleteIngestion([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'ingestionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

DeleteIngestionDestination

$result = $client->deleteIngestionDestination([/* ... */]);
$promise = $client->deleteIngestionDestinationAsync([/* ... */]);

Deletes an ingestion destination.

This deletes the association between an ingestion and it's destination. It doesn't delete previously ingested data or the storage destination, such as the Amazon S3 bucket where the data is delivered. If the ingestion destination is deleted while the associated ingestion is enabled, the ingestion will fail and is eventually disabled.

Parameter Syntax

$result = $client->deleteIngestionDestination([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'ingestionDestinationIdentifier' => '<string>', // REQUIRED
    'ingestionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

GetAppAuthorization

$result = $client->getAppAuthorization([/* ... */]);
$promise = $client->getAppAuthorizationAsync([/* ... */]);

Returns information about an app authorization.

Parameter Syntax

$result = $client->getAppAuthorization([
    'appAuthorizationIdentifier' => '<string>', // REQUIRED
    'appBundleIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appAuthorization' => [
        'app' => '<string>',
        'appAuthorizationArn' => '<string>',
        'appBundleArn' => '<string>',
        'authType' => 'oauth2|apiKey',
        'authUrl' => '<string>',
        'createdAt' => <DateTime>,
        'persona' => 'admin|endUser',
        'status' => 'PendingConnect|Connected|ConnectionValidationFailed|TokenAutoRotationFailed',
        'tenant' => [
            'tenantDisplayName' => '<string>',
            'tenantIdentifier' => '<string>',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

GetAppBundle

$result = $client->getAppBundle([/* ... */]);
$promise = $client->getAppBundleAsync([/* ... */]);

Returns information about an app bundle.

Parameter Syntax

$result = $client->getAppBundle([
    'appBundleIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appBundle' => [
        'arn' => '<string>',
        'customerManagedKeyArn' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

GetIngestion

$result = $client->getIngestion([/* ... */]);
$promise = $client->getIngestionAsync([/* ... */]);

Returns information about an ingestion.

Parameter Syntax

$result = $client->getIngestion([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'ingestionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ingestion' => [
        'app' => '<string>',
        'appBundleArn' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'ingestionType' => 'auditLog',
        'state' => 'enabled|disabled',
        'tenantId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

GetIngestionDestination

$result = $client->getIngestionDestination([/* ... */]);
$promise = $client->getIngestionDestinationAsync([/* ... */]);

Returns information about an ingestion destination.

Parameter Syntax

$result = $client->getIngestionDestination([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'ingestionDestinationIdentifier' => '<string>', // REQUIRED
    'ingestionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ingestionDestination' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'destinationConfiguration' => [
            'auditLog' => [
                'destination' => [
                    'firehoseStream' => [
                        'streamName' => '<string>',
                    ],
                    's3Bucket' => [
                        'bucketName' => '<string>',
                        'prefix' => '<string>',
                    ],
                ],
            ],
        ],
        'ingestionArn' => '<string>',
        'processingConfiguration' => [
            'auditLog' => [
                'format' => 'json|parquet',
                'schema' => 'ocsf|raw',
            ],
        ],
        'status' => 'Active|Failed',
        'statusReason' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

ListAppAuthorizations

$result = $client->listAppAuthorizations([/* ... */]);
$promise = $client->listAppAuthorizationsAsync([/* ... */]);

Returns a list of all app authorizations configured for an app bundle.

Parameter Syntax

$result = $client->listAppAuthorizations([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appAuthorizationSummaryList' => [
        [
            'app' => '<string>',
            'appAuthorizationArn' => '<string>',
            'appBundleArn' => '<string>',
            'status' => 'PendingConnect|Connected|ConnectionValidationFailed|TokenAutoRotationFailed',
            'tenant' => [
                'tenantDisplayName' => '<string>',
                'tenantIdentifier' => '<string>',
            ],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

ListAppBundles

$result = $client->listAppBundles([/* ... */]);
$promise = $client->listAppBundlesAsync([/* ... */]);

Returns a list of app bundles.

Parameter Syntax

$result = $client->listAppBundles([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appBundleSummaryList' => [
        [
            'arn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

AccessDeniedException:

You are not authorized to perform this operation.

ListIngestionDestinations

$result = $client->listIngestionDestinations([/* ... */]);
$promise = $client->listIngestionDestinationsAsync([/* ... */]);

Returns a list of all ingestion destinations configured for an ingestion.

Parameter Syntax

$result = $client->listIngestionDestinations([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'ingestionIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ingestionDestinations' => [
        [
            'arn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

ListIngestions

$result = $client->listIngestions([/* ... */]);
$promise = $client->listIngestionsAsync([/* ... */]);

Returns a list of all ingestions configured for an app bundle.

Parameter Syntax

$result = $client->listIngestions([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ingestions' => [
        [
            'app' => '<string>',
            'arn' => '<string>',
            'state' => 'enabled|disabled',
            'tenantId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

StartIngestion

$result = $client->startIngestion([/* ... */]);
$promise = $client->startIngestionAsync([/* ... */]);

Starts (enables) an ingestion, which collects data from an application.

Parameter Syntax

$result = $client->startIngestion([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'ingestionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ConflictException:

The request has created a conflict. Check the request parameters and try again.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

StartUserAccessTasks

$result = $client->startUserAccessTasks([/* ... */]);
$promise = $client->startUserAccessTasksAsync([/* ... */]);

Starts the tasks to search user access status for a specific email address.

The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.

Parameter Syntax

$result = $client->startUserAccessTasks([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'email' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'userAccessTasksList' => [
        [
            'app' => '<string>',
            'error' => [
                'errorCode' => '<string>',
                'errorMessage' => '<string>',
            ],
            'taskId' => '<string>',
            'tenantId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

StopIngestion

$result = $client->stopIngestion([/* ... */]);
$promise = $client->stopIngestionAsync([/* ... */]);

Stops (disables) an ingestion.

Parameter Syntax

$result = $client->stopIngestion([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'ingestionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ConflictException:

The request has created a conflict. Check the request parameters and try again.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one or more tags (key-value pairs) to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag or tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

UpdateAppAuthorization

$result = $client->updateAppAuthorization([/* ... */]);
$promise = $client->updateAppAuthorizationAsync([/* ... */]);

Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.

If the app authorization was in a connected state, updating the app authorization will set it back to a PendingConnect state.

Parameter Syntax

$result = $client->updateAppAuthorization([
    'appAuthorizationIdentifier' => '<string>', // REQUIRED
    'appBundleIdentifier' => '<string>', // REQUIRED
    'credential' => [
        'apiKeyCredential' => [
            'apiKey' => '<string>', // REQUIRED
        ],
        'oauth2Credential' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
        ],
    ],
    'tenant' => [
        'tenantDisplayName' => '<string>', // REQUIRED
        'tenantIdentifier' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'appAuthorization' => [
        'app' => '<string>',
        'appAuthorizationArn' => '<string>',
        'appBundleArn' => '<string>',
        'authType' => 'oauth2|apiKey',
        'authUrl' => '<string>',
        'createdAt' => <DateTime>,
        'persona' => 'admin|endUser',
        'status' => 'PendingConnect|Connected|ConnectionValidationFailed|TokenAutoRotationFailed',
        'tenant' => [
            'tenantDisplayName' => '<string>',
            'tenantIdentifier' => '<string>',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ThrottlingException:

The request rate exceeds the limit.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.

UpdateIngestionDestination

$result = $client->updateIngestionDestination([/* ... */]);
$promise = $client->updateIngestionDestinationAsync([/* ... */]);

Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

Parameter Syntax

$result = $client->updateIngestionDestination([
    'appBundleIdentifier' => '<string>', // REQUIRED
    'destinationConfiguration' => [ // REQUIRED
        'auditLog' => [
            'destination' => [ // REQUIRED
                'firehoseStream' => [
                    'streamName' => '<string>', // REQUIRED
                ],
                's3Bucket' => [
                    'bucketName' => '<string>', // REQUIRED
                    'prefix' => '<string>',
                ],
            ],
        ],
    ],
    'ingestionDestinationIdentifier' => '<string>', // REQUIRED
    'ingestionIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ingestionDestination' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'destinationConfiguration' => [
            'auditLog' => [
                'destination' => [
                    'firehoseStream' => [
                        'streamName' => '<string>',
                    ],
                    's3Bucket' => [
                        'bucketName' => '<string>',
                        'prefix' => '<string>',
                    ],
                ],
            ],
        ],
        'ingestionArn' => '<string>',
        'processingConfiguration' => [
            'auditLog' => [
                'format' => 'json|parquet',
                'schema' => 'ocsf|raw',
            ],
        ],
        'status' => 'Active|Failed',
        'statusReason' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ServiceQuotaExceededException:

The request exceeds a service quota.

ThrottlingException:

The request rate exceeds the limit.

ConflictException:

The request has created a conflict. Check the request parameters and try again.

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

You are not authorized to perform this operation.