String apiKey
An API key for an application.
String appAuthorizationArn
The Amazon Resource Name (ARN) of the app authorization.
String appBundleArn
The Amazon Resource Name (ARN) of the app bundle for the app authorization.
String app
The name of the application.
Tenant tenant
Contains information about an application tenant, such as the application display name and identifier.
String authType
The authorization type.
String 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.
Date createdAt
The timestamp of when the app authorization was created.
Date updatedAt
The timestamp of when the app authorization was last updated.
String persona
The user persona of the app authorization.
This field should always be admin.
String authUrl
The application URL for the OAuth flow.
String appAuthorizationArn
The Amazon Resource Name (ARN) of the app authorization.
String appBundleArn
The Amazon Resource Name (ARN) of the app bundle for the app authorization.
String app
The name of the application.
Tenant tenant
Contains information about an application tenant, such as the application display name and identifier.
String 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.
Date updatedAt
Timestamp for when the app authorization was last updated.
String arn
The Amazon Resource Name (ARN) of the app bundle.
Destination destination
Contains information about an audit log destination.
String 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.
String appAuthorizationIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
AuthRequest authRequest
Contains OAuth2 authorization information.
This is required if the app authorization for the request is configured with an OAuth2 (oauth2)
authorization type.
AppAuthorizationSummary appAuthorizationSummary
Contains a summary of the app authorization.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String app
The name of the application.
Valid values are:
SLACK
ASANA
JIRA
M365
M365AUDITLOGS
ZOOM
ZENDESK
OKTA
GOOGLE
DROPBOX
SMARTSHEET
CISCO
Credential 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.
Tenant tenant
Contains information about an application tenant, such as the application display name and identifier.
String authType
The authorization type for the app authorization.
String 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.
List<E> tags
A map of the key-value pairs of the tag or tags to assign to the resource.
AppAuthorization appAuthorization
Contains information about an app authorization.
String 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.
String 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.
List<E> tags
A map of the key-value pairs of the tag or tags to assign to the resource.
AppBundle appBundle
Contains information about an app bundle.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String ingestionIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
ProcessingConfiguration processingConfiguration
Contains information about how ingested data is processed.
DestinationConfiguration destinationConfiguration
Contains information about the destination of ingested data.
String 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.
List<E> tags
A map of the key-value pairs of the tag or tags to assign to the resource.
IngestionDestination ingestionDestination
Contains information about an ingestion destination.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String app
The name of the application.
Valid values are:
SLACK
ASANA
JIRA
M365
M365AUDITLOGS
ZOOM
ZENDESK
OKTA
GOOGLE
DROPBOX
SMARTSHEET
CISCO
String tenantId
The ID of the application tenant.
String ingestionType
The ingestion type.
String 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.
List<E> tags
A map of the key-value pairs of the tag or tags to assign to the resource.
Ingestion ingestion
Contains information about an ingestion.
Oauth2Credential oauth2Credential
Contains OAuth2 client credential information.
ApiKeyCredential apiKeyCredential
Contains API key credential information.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String appAuthorizationIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
String appBundleIdentifier
The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String ingestionIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
String ingestionDestinationIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String ingestionIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
S3Bucket s3Bucket
Contains information about an Amazon S3 bucket.
FirehoseStream firehoseStream
Contains information about an Amazon Kinesis Data Firehose delivery stream.
AuditLogDestinationConfiguration auditLog
Contains information about an audit log destination configuration.
String streamName
The name of the Amazon Kinesis Data Firehose delivery stream.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String appAuthorizationIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
AppAuthorization appAuthorization
Contains information about an app authorization.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
AppBundle appBundle
Contains information about an app bundle.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String ingestionIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
String ingestionDestinationIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
IngestionDestination ingestionDestination
Contains information about an ingestion destination.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String ingestionIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
Ingestion ingestion
Contains information about an ingestion.
String arn
The Amazon Resource Name (ARN) of the ingestion.
String appBundleArn
The Amazon Resource Name (ARN) of the app bundle for the ingestion.
String app
The name of the application.
String tenantId
The ID of the application tenant.
Date createdAt
The timestamp of when the ingestion was created.
Date updatedAt
The timestamp of when the ingestion was last updated.
String state
The status of the ingestion.
String ingestionType
The type of the ingestion.
String arn
The Amazon Resource Name (ARN) of the ingestion destination.
String ingestionArn
The Amazon Resource Name (ARN) of the ingestion.
ProcessingConfiguration processingConfiguration
Contains information about how ingested data is processed.
DestinationConfiguration destinationConfiguration
Contains information about the destination of ingested data.
String 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.
String statusReason
The reason for the current status of the ingestion destination.
Only present when the status of ingestion destination is Failed.
Date createdAt
The timestamp of when the ingestion destination was created.
Date updatedAt
The timestamp of when the ingestion destination was last updated.
String arn
The Amazon Resource Name (ARN) of the ingestion destination.
Integer retryAfterSeconds
The period of time after which you should retry your request.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
Integer 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.
String 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.
List<E> appAuthorizationSummaryList
Contains a list of app authorization summaries.
String 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.
Integer 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.
String 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.
List<E> appBundleSummaryList
Contains a list of app bundle summaries.
String 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.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String ingestionIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
Integer 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.
String 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.
List<E> ingestionDestinations
Contains a list of ingestion destination summaries.
String 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.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
Integer 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.
String 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.
List<E> ingestions
Contains a list of ingestion summaries.
String 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.
String resourceArn
The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
AuditLogProcessingConfiguration auditLog
Contains information about an audit log processing configuration.
String ingestionIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String ingestionIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String appAuthorizationIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
Credential credential
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.
Tenant tenant
Contains information about an application tenant, such as the application display name and identifier.
AppAuthorization appAuthorization
Contains information about an app authorization.
String appBundleIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
String ingestionIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
String ingestionDestinationIdentifier
The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
DestinationConfiguration destinationConfiguration
Contains information about the destination of ingested data.
IngestionDestination ingestionDestination
Contains information about an ingestion destination.
String app
The name of the application.
String tenantId
The ID of the application tenant.
String tenantDisplayName
The display name of the tenant.
String taskId
The unique ID of the task.
String 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.
String email
The email address of the target user.
String userId
The unique ID of user.
String userFullName
The full name of the user.
String userFirstName
The first name of the user.
String userLastName
The last name of the user.
String userStatus
The status of the user returned by the application.
TaskError taskError
Contains information about an error returned from a user access task.
Copyright © 2024. All rights reserved.