Amazon Web Services AppFabric quickly connects software as a service (SaaS) applications across your organization. This allows IT and security teams to easily manage and secure applications using a standard schema, and employees can complete everyday tasks faster using generative artificial intelligence (AI). You can use these APIs to complete AppFabric tasks, such as setting up audit log ingestions or viewing user access. For more information about AppFabric, including the required permissions to use the service, see the Amazon Web Services AppFabric Administration Guide. For more information about using the Command Line Interface (CLI) to manage your AppFabric resources, see the AppFabric section of the CLI Reference.
', 'operations' => [ 'BatchGetUserAccessTasks' => 'Gets user access details in a batch request.
This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.
Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.
', 'CreateAppAuthorization' => 'Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.
', 'CreateAppBundle' => 'Creates an app bundle to collect data from an application using AppFabric.
', 'CreateIngestion' => 'Creates a data ingestion for an application.
', 'CreateIngestionDestination' => 'Creates an ingestion destination, which specifies how an application\'s ingested data is processed by Amazon Web Services AppFabric and where it\'s delivered.
', 'DeleteAppAuthorization' => 'Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.
', 'DeleteAppBundle' => 'Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.
', 'DeleteIngestion' => 'Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.
', 'DeleteIngestionDestination' => '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.
', 'GetAppAuthorization' => 'Returns information about an app authorization.
', 'GetAppBundle' => 'Returns information about an app bundle.
', 'GetIngestion' => 'Returns information about an ingestion.
', 'GetIngestionDestination' => 'Returns information about an ingestion destination.
', 'ListAppAuthorizations' => 'Returns a list of all app authorizations configured for an app bundle.
', 'ListAppBundles' => 'Returns a list of app bundles.
', 'ListIngestionDestinations' => 'Returns a list of all ingestion destinations configured for an ingestion.
', 'ListIngestions' => 'Returns a list of all ingestions configured for an app bundle.
', 'ListTagsForResource' => 'Returns a list of tags for a resource.
', 'StartIngestion' => 'Starts (enables) an ingestion, which collects data from an application.
', 'StartUserAccessTasks' => '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.
', 'StopIngestion' => 'Stops (disables) an ingestion.
', 'TagResource' => 'Assigns one or more tags (key-value pairs) to the specified resource.
', 'UntagResource' => 'Removes a tag or tags from a resource.
', 'UpdateAppAuthorization' => '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.
Updates an ingestion destination, which specifies how an application\'s ingested data is processed by Amazon Web Services AppFabric and where it\'s delivered.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You are not authorized to perform this operation.
', 'refs' => [], ], 'ApiKeyCredential' => [ 'base' => 'Contains API key credential information.
', 'refs' => [ 'Credential$apiKeyCredential' => 'Contains API key credential information.
', ], ], 'AppAuthorization' => [ 'base' => 'Contains information about an app authorization.
', 'refs' => [ 'CreateAppAuthorizationResponse$appAuthorization' => 'Contains information about an app authorization.
', 'GetAppAuthorizationResponse$appAuthorization' => 'Contains information about an app authorization.
', 'UpdateAppAuthorizationResponse$appAuthorization' => 'Contains information about an app authorization.
', ], ], 'AppAuthorizationStatus' => [ 'base' => NULL, 'refs' => [ 'AppAuthorization$status' => 'The state of the app authorization.
The following states are possible:
PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.
Connected: The app authorization is connected to the application, and is ready to be used.
ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.
TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.
The state of the app authorization.
The following states are possible:
PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.
Connected: The app authorization is connected to the application, and is ready to be used.
ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.
TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.
Contains a summary of an app authorization.
', 'refs' => [ 'AppAuthorizationSummaryList$member' => NULL, 'ConnectAppAuthorizationResponse$appAuthorizationSummary' => 'Contains a summary of the app authorization.
', ], ], 'AppAuthorizationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAppAuthorizationsResponse$appAuthorizationSummaryList' => 'Contains a list of app authorization summaries.
', ], ], 'AppBundle' => [ 'base' => 'Contains information about an app bundle.
', 'refs' => [ 'CreateAppBundleResponse$appBundle' => 'Contains information about an app bundle.
', 'GetAppBundleResponse$appBundle' => 'Contains information about an app bundle.
', ], ], 'AppBundleSummary' => [ 'base' => 'Contains a summary of an app bundle.
', 'refs' => [ 'AppBundleSummaryList$member' => NULL, ], ], 'AppBundleSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAppBundlesResponse$appBundleSummaryList' => 'Contains a list of app bundle summaries.
', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AppAuthorization$appAuthorizationArn' => 'The Amazon Resource Name (ARN) of the app authorization.
', 'AppAuthorization$appBundleArn' => 'The Amazon Resource Name (ARN) of the app bundle for the app authorization.
', 'AppAuthorizationSummary$appAuthorizationArn' => 'The Amazon Resource Name (ARN) of the app authorization.
', 'AppAuthorizationSummary$appBundleArn' => 'The Amazon Resource Name (ARN) of the app bundle for the app authorization.
', 'AppBundle$arn' => 'The Amazon Resource Name (ARN) of the app bundle.
', 'AppBundle$customerManagedKeyArn' => 'The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the application data.
', 'AppBundleSummary$arn' => 'The Amazon Resource Name (ARN) of the app bundle.
', 'Ingestion$arn' => 'The Amazon Resource Name (ARN) of the ingestion.
', 'Ingestion$appBundleArn' => 'The Amazon Resource Name (ARN) of the app bundle for the ingestion.
', 'IngestionDestination$arn' => 'The Amazon Resource Name (ARN) of the ingestion destination.
', 'IngestionDestination$ingestionArn' => 'The Amazon Resource Name (ARN) of the ingestion.
', 'IngestionDestinationSummary$arn' => 'The Amazon Resource Name (ARN) of the ingestion destination.
', 'IngestionSummary$arn' => 'The Amazon Resource Name (ARN) of the ingestion.
', 'ListTagsForResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
', 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource that you want to tag.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource that you want to untag.
', ], ], 'AuditLogDestinationConfiguration' => [ 'base' => 'Contains information about an audit log destination configuration.
', 'refs' => [ 'DestinationConfiguration$auditLog' => 'Contains information about an audit log destination configuration.
', ], ], 'AuditLogProcessingConfiguration' => [ 'base' => 'Contains information about an audit log processing configuration.
', 'refs' => [ 'ProcessingConfiguration$auditLog' => 'Contains information about an audit log processing configuration.
', ], ], 'AuthRequest' => [ 'base' => 'Contains authorization request information, which is required for Amazon Web Services AppFabric to get the OAuth2 access token for an application.
', 'refs' => [ 'ConnectAppAuthorizationRequest$authRequest' => 'Contains OAuth2 authorization information.
This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
The authorization type.
', 'CreateAppAuthorizationRequest$authType' => 'The authorization type for the app authorization.
', ], ], 'BatchGetUserAccessTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetUserAccessTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConflictException' => [ 'base' => 'The request has created a conflict. Check the request parameters and try again.
', 'refs' => [], ], 'ConnectAppAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConnectAppAuthorizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppAuthorizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppBundleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAppBundleResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIngestionDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIngestionDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Credential' => [ 'base' => 'Contains credential information for an application.
', 'refs' => [ 'CreateAppAuthorizationRequest$credential' => 'Contains credentials for the application, such as an API key or OAuth2 client ID and secret.
Specify credentials that match the authorization type for your request. For example, if the authorization type for your request is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.
Contains credentials for the application, such as an API key or OAuth2 client ID and secret.
Specify credentials that match the authorization type of the app authorization to update. For example, if the authorization type of the app authorization is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.
The timestamp of when the app authorization was created.
', 'AppAuthorization$updatedAt' => 'The timestamp of when the app authorization was last updated.
', 'AppAuthorizationSummary$updatedAt' => 'Timestamp for when the app authorization was last updated.
', 'Ingestion$createdAt' => 'The timestamp of when the ingestion was created.
', 'Ingestion$updatedAt' => 'The timestamp of when the ingestion was last updated.
', 'IngestionDestination$createdAt' => 'The timestamp of when the ingestion destination was created.
', 'IngestionDestination$updatedAt' => 'The timestamp of when the ingestion destination was last updated.
', ], ], 'DeleteAppAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppAuthorizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppBundleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAppBundleResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIngestionDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIngestionDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Destination' => [ 'base' => 'Contains information about an audit log destination.
', 'refs' => [ 'AuditLogDestinationConfiguration$destination' => 'Contains information about an audit log destination.
', ], ], 'DestinationConfiguration' => [ 'base' => 'Contains information about the destination of ingested data.
', 'refs' => [ 'CreateIngestionDestinationRequest$destinationConfiguration' => 'Contains information about the destination of ingested data.
', 'IngestionDestination$destinationConfiguration' => 'Contains information about the destination of ingested data.
', 'UpdateIngestionDestinationRequest$destinationConfiguration' => 'Contains information about the destination of ingested data.
', ], ], 'Email' => [ 'base' => NULL, 'refs' => [ 'StartUserAccessTasksRequest$email' => 'The email address of the target user.
', 'UserAccessResultItem$email' => 'The email address of the target user.
', ], ], 'FirehoseStream' => [ 'base' => 'Contains information about an Amazon Kinesis Data Firehose delivery stream.
', 'refs' => [ 'Destination$firehoseStream' => 'Contains information about an Amazon Kinesis Data Firehose delivery stream.
', ], ], 'Format' => [ 'base' => NULL, 'refs' => [ 'AuditLogProcessingConfiguration$format' => 'The format in which the audit logs need to be formatted.
', ], ], 'GetAppAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAppAuthorizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAppBundleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAppBundleResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIngestionDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIngestionDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Identifier' => [ 'base' => NULL, 'refs' => [ 'BatchGetUserAccessTasksRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'ConnectAppAuthorizationRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization to use for the request.
', 'ConnectAppAuthorizationRequest$appAuthorizationIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
', 'CreateAppAuthorizationRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'CreateAppBundleRequest$customerManagedKeyIdentifier' => 'The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use to encrypt the application data. If this is not specified, an Amazon Web Services owned key is used for encryption.
', 'CreateIngestionDestinationRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'CreateIngestionDestinationRequest$ingestionIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
', 'CreateIngestionRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'DeleteAppAuthorizationRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'DeleteAppAuthorizationRequest$appAuthorizationIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
', 'DeleteAppBundleRequest$appBundleIdentifier' => 'The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.
', 'DeleteIngestionDestinationRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'DeleteIngestionDestinationRequest$ingestionIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
', 'DeleteIngestionDestinationRequest$ingestionDestinationIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
', 'DeleteIngestionRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'DeleteIngestionRequest$ingestionIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
', 'GetAppAuthorizationRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'GetAppAuthorizationRequest$appAuthorizationIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
', 'GetAppBundleRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'GetIngestionDestinationRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'GetIngestionDestinationRequest$ingestionIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
', 'GetIngestionDestinationRequest$ingestionDestinationIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
', 'GetIngestionRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'GetIngestionRequest$ingestionIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
', 'ListAppAuthorizationsRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'ListIngestionDestinationsRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'ListIngestionDestinationsRequest$ingestionIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
', 'ListIngestionsRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'StartIngestionRequest$ingestionIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
', 'StartIngestionRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'StartUserAccessTasksRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'StopIngestionRequest$ingestionIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
', 'StopIngestionRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'UpdateAppAuthorizationRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'UpdateAppAuthorizationRequest$appAuthorizationIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
', 'UpdateIngestionDestinationRequest$appBundleIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
', 'UpdateIngestionDestinationRequest$ingestionIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
', 'UpdateIngestionDestinationRequest$ingestionDestinationIdentifier' => 'The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
', ], ], 'Ingestion' => [ 'base' => 'Contains information about an ingestion.
', 'refs' => [ 'CreateIngestionResponse$ingestion' => 'Contains information about an ingestion.
', 'GetIngestionResponse$ingestion' => 'Contains information about an ingestion.
', ], ], 'IngestionDestination' => [ 'base' => 'Contains information about an ingestion destination.
', 'refs' => [ 'CreateIngestionDestinationResponse$ingestionDestination' => 'Contains information about an ingestion destination.
', 'GetIngestionDestinationResponse$ingestionDestination' => 'Contains information about an ingestion destination.
', 'UpdateIngestionDestinationResponse$ingestionDestination' => 'Contains information about an ingestion destination.
', ], ], 'IngestionDestinationList' => [ 'base' => NULL, 'refs' => [ 'ListIngestionDestinationsResponse$ingestionDestinations' => 'Contains a list of ingestion destination summaries.
', ], ], 'IngestionDestinationStatus' => [ 'base' => NULL, 'refs' => [ 'IngestionDestination$status' => 'The state of the ingestion destination.
The following states are possible:
Active: The ingestion destination is active and is ready to be used.
Failed: The ingestion destination has failed. If the ingestion destination is in this state, you should verify the ingestion destination configuration and try again.
Contains a summary of an ingestion destination.
', 'refs' => [ 'IngestionDestinationList$member' => NULL, ], ], 'IngestionList' => [ 'base' => NULL, 'refs' => [ 'ListIngestionsResponse$ingestions' => 'Contains a list of ingestion summaries.
', ], ], 'IngestionState' => [ 'base' => NULL, 'refs' => [ 'Ingestion$state' => 'The status of the ingestion.
', 'IngestionSummary$state' => 'The status of the ingestion.
', ], ], 'IngestionSummary' => [ 'base' => 'Contains a summary of an ingestion.
', 'refs' => [ 'IngestionList$member' => NULL, ], ], 'IngestionType' => [ 'base' => NULL, 'refs' => [ 'CreateIngestionRequest$ingestionType' => 'The ingestion type.
', 'Ingestion$ingestionType' => 'The type of the ingestion.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'InternalServerException$retryAfterSeconds' => 'The period of time after which you should retry your request.
', 'ThrottlingException$retryAfterSeconds' => 'The period of time after which you should retry your request.
', ], ], 'InternalServerException' => [ 'base' => 'The request processing has failed because of an unknown error, exception, or failure with an internal server.
', 'refs' => [], ], 'ListAppAuthorizationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppAuthorizationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAppBundlesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAppBundlesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIngestionDestinationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIngestionDestinationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListIngestionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIngestionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAppAuthorizationsRequest$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', 'ListAppBundlesRequest$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', 'ListIngestionDestinationsRequest$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', 'ListIngestionsRequest$maxResults' => 'The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
', ], ], 'Oauth2Credential' => [ 'base' => 'Contains OAuth2 client credential information.
', 'refs' => [ 'Credential$oauth2Credential' => 'Contains OAuth2 client credential information.
', ], ], 'Persona' => [ 'base' => NULL, 'refs' => [ 'AppAuthorization$persona' => 'The user persona of the app authorization.
This field should always be admin.
Contains information about how ingested data is processed.
', 'refs' => [ 'CreateIngestionDestinationRequest$processingConfiguration' => 'Contains information about how ingested data is processed.
', 'IngestionDestination$processingConfiguration' => 'Contains information about how ingested data is processed.
', ], ], 'RedirectUri' => [ 'base' => NULL, 'refs' => [ 'AuthRequest$redirectUri' => 'The redirect URL that is specified in the AuthURL and the application client.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource does not exist.
', 'refs' => [], ], 'ResultStatus' => [ 'base' => NULL, 'refs' => [ 'UserAccessResultItem$resultStatus' => 'The status of the user access result item.
The following states are possible:
IN_PROGRESS: The user access task is in progress.
COMPLETED: The user access task completed successfully.
FAILED: The user access task failed.
EXPIRED: The user access task expired.
Contains information about an Amazon S3 bucket.
', 'refs' => [ 'Destination$s3Bucket' => 'Contains information about an Amazon S3 bucket.
', ], ], 'Schema' => [ 'base' => NULL, 'refs' => [ 'AuditLogProcessingConfiguration$schema' => 'The event schema in which the audit logs need to be formatted.
', ], ], 'SensitiveString2048' => [ 'base' => NULL, 'refs' => [ 'ApiKeyCredential$apiKey' => 'An API key for an application.
', 'AuthRequest$code' => 'The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL).
', 'Oauth2Credential$clientSecret' => 'The client secret of the client application.
', 'UserAccessResultItem$userId' => 'The unique ID of user.
', 'UserAccessResultItem$userFullName' => 'The full name of the user.
', 'UserAccessResultItem$userFirstName' => 'The first name of the user.
', 'UserAccessResultItem$userLastName' => 'The last name of the user.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'The request exceeds a service quota.
', 'refs' => [], ], 'StartIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartUserAccessTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartUserAccessTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopIngestionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopIngestionResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'AppAuthorization$authUrl' => 'The application URL for the OAuth flow.
', 'ConflictException$message' => NULL, 'ConflictException$resourceId' => 'The resource ID.
', 'ConflictException$resourceType' => 'The resource type.
', 'IngestionDestination$statusReason' => 'The reason for the current status of the ingestion destination.
Only present when the status of ingestion destination is Failed.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The resource ID.
', 'ResourceNotFoundException$resourceType' => 'The resource type.
', 'ServiceQuotaExceededException$message' => NULL, 'ServiceQuotaExceededException$resourceId' => 'The resource ID.
', 'ServiceQuotaExceededException$resourceType' => 'The resource type.
', 'ServiceQuotaExceededException$serviceCode' => 'The code of the service.
', 'ServiceQuotaExceededException$quotaCode' => 'The code for the quota exceeded.
', 'TaskError$errorCode' => 'The code of the error.
', 'TaskError$errorMessage' => 'The message of the error.
', 'ThrottlingException$message' => NULL, 'ThrottlingException$serviceCode' => 'The code of the service.
', 'ThrottlingException$quotaCode' => 'The code for the quota exceeded.
', 'UserAccessResultItem$userStatus' => 'The status of the user returned by the application.
', 'ValidationException$message' => NULL, 'ValidationExceptionField$name' => 'The field name where the invalid entry was detected.
', 'ValidationExceptionField$message' => 'A message about the validation exception.
', ], ], 'String120' => [ 'base' => NULL, 'refs' => [ 'S3Bucket$prefix' => 'The object key to use.
', ], ], 'String2048' => [ 'base' => NULL, 'refs' => [ 'ListAppAuthorizationsRequest$nextToken' => 'If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The client ID of the client application.
', 'Tenant$tenantDisplayName' => 'The display name of the tenant.
', 'UserAccessResultItem$tenantDisplayName' => 'The display name of the tenant.
', ], ], 'String255' => [ 'base' => NULL, 'refs' => [ 'AppAuthorization$app' => 'The name of the application.
', 'AppAuthorizationSummary$app' => 'The name of the application.
', 'CreateAppAuthorizationRequest$app' => 'The name of the application.
Valid values are:
SLACK
ASANA
JIRA
M365
M365AUDITLOGS
ZOOM
ZENDESK
OKTA
GOOGLE
DROPBOX
SMARTSHEET
CISCO
The name of the application.
Valid values are:
SLACK
ASANA
JIRA
M365
M365AUDITLOGS
ZOOM
ZENDESK
OKTA
GOOGLE
DROPBOX
SMARTSHEET
CISCO
The name of the application.
', 'IngestionSummary$app' => 'The name of the application.
', 'UserAccessResultItem$app' => 'The name of the application.
', 'UserAccessTaskItem$app' => 'The name of the application.
', ], ], 'String63' => [ 'base' => NULL, 'refs' => [ 'S3Bucket$bucketName' => 'The name of the Amazon S3 bucket.
', ], ], 'String64' => [ 'base' => NULL, 'refs' => [ 'FirehoseStream$streamName' => 'The name of the Amazon Kinesis Data Firehose delivery stream.
', ], ], 'Tag' => [ 'base' => 'The key or keys of the key-value pairs for the tag or tags assigned to a resource.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'Tag key.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateAppAuthorizationRequest$tags' => 'A map of the key-value pairs of the tag or tags to assign to the resource.
', 'CreateAppBundleRequest$tags' => 'A map of the key-value pairs of the tag or tags to assign to the resource.
', 'CreateIngestionDestinationRequest$tags' => 'A map of the key-value pairs of the tag or tags to assign to the resource.
', 'CreateIngestionRequest$tags' => 'A map of the key-value pairs of the tag or tags to assign to the resource.
', 'ListTagsForResourceResponse$tags' => 'A map of the key-value pairs for the tag or tags assigned to the specified resource.
', 'TagResourceRequest$tags' => 'A map of the key-value pairs of the tag or tags to assign to the resource.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'Tag value.
', ], ], 'TaskError' => [ 'base' => 'Contains information about an error returned from a user access task.
', 'refs' => [ 'UserAccessResultItem$taskError' => 'Contains information about an error returned from a user access task.
', 'UserAccessTaskItem$error' => 'Error from the task, if any.
', ], ], 'TaskIdList' => [ 'base' => NULL, 'refs' => [ 'BatchGetUserAccessTasksRequest$taskIdList' => 'The tasks IDs to use for the request.
', ], ], 'Tenant' => [ 'base' => 'Contains information about an application tenant.
', 'refs' => [ 'AppAuthorization$tenant' => 'Contains information about an application tenant, such as the application display name and identifier.
', 'AppAuthorizationSummary$tenant' => 'Contains information about an application tenant, such as the application display name and identifier.
', 'CreateAppAuthorizationRequest$tenant' => 'Contains information about an application tenant, such as the application display name and identifier.
', 'UpdateAppAuthorizationRequest$tenant' => 'Contains information about an application tenant, such as the application display name and identifier.
', ], ], 'TenantIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateIngestionRequest$tenantId' => 'The ID of the application tenant.
', 'Ingestion$tenantId' => 'The ID of the application tenant.
', 'IngestionSummary$tenantId' => 'The ID of the application tenant.
', 'Tenant$tenantIdentifier' => 'The ID of the application tenant.
', 'UserAccessResultItem$tenantId' => 'The ID of the application tenant.
', 'UserAccessTaskItem$tenantId' => 'The ID of the application tenant.
', ], ], 'ThrottlingException' => [ 'base' => 'The request rate exceeds the limit.
', 'refs' => [], ], 'UUID' => [ 'base' => NULL, 'refs' => [ 'CreateAppAuthorizationRequest$clientToken' => 'Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don\'t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don\'t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don\'t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don\'t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The unique ID of the task.
', 'UserAccessTaskItem$taskId' => 'The unique ID of the task.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppAuthorizationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAppAuthorizationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIngestionDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateIngestionDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UserAccessResultItem' => [ 'base' => 'Contains information about a user\'s access to an application.
', 'refs' => [ 'UserAccessResultsList$member' => NULL, ], ], 'UserAccessResultsList' => [ 'base' => NULL, 'refs' => [ 'BatchGetUserAccessTasksResponse$userAccessResultsList' => 'Contains a list of user access results.
', ], ], 'UserAccessTaskItem' => [ 'base' => 'Contains information about a user access task.
', 'refs' => [ 'UserAccessTasksList$member' => NULL, ], ], 'UserAccessTasksList' => [ 'base' => NULL, 'refs' => [ 'StartUserAccessTasksResponse$userAccessTasksList' => 'Contains a list of user access task information.
', ], ], 'ValidationException' => [ 'base' => 'The request has invalid or missing parameters.
', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => 'The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.
', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fieldList' => 'The field list.
', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => 'The reason for the exception.
', ], ], ],];