

# Data Types
<a name="API_Types"></a>

The AppFabric API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [ApiKeyCredential](API_ApiKeyCredential.md) 
+  [AppAuthorization](API_AppAuthorization.md) 
+  [AppAuthorizationSummary](API_AppAuthorizationSummary.md) 
+  [AppBundle](API_AppBundle.md) 
+  [AppBundleSummary](API_AppBundleSummary.md) 
+  [AuditLogDestinationConfiguration](API_AuditLogDestinationConfiguration.md) 
+  [AuditLogProcessingConfiguration](API_AuditLogProcessingConfiguration.md) 
+  [AuthRequest](API_AuthRequest.md) 
+  [Credential](API_Credential.md) 
+  [Destination](API_Destination.md) 
+  [DestinationConfiguration](API_DestinationConfiguration.md) 
+  [FirehoseStream](API_FirehoseStream.md) 
+  [Ingestion](API_Ingestion.md) 
+  [IngestionDestination](API_IngestionDestination.md) 
+  [IngestionDestinationSummary](API_IngestionDestinationSummary.md) 
+  [IngestionSummary](API_IngestionSummary.md) 
+  [Oauth2Credential](API_Oauth2Credential.md) 
+  [ProcessingConfiguration](API_ProcessingConfiguration.md) 
+  [S3Bucket](API_S3Bucket.md) 
+  [Tag](API_Tag.md) 
+  [TaskError](API_TaskError.md) 
+  [Tenant](API_Tenant.md) 
+  [UserAccessResultItem](API_UserAccessResultItem.md) 
+  [UserAccessTaskItem](API_UserAccessTaskItem.md) 
+  [ValidationExceptionField](API_ValidationExceptionField.md) 

# ApiKeyCredential
<a name="API_ApiKeyCredential"></a>

Contains API key credential information.

## Contents
<a name="API_ApiKeyCredential_Contents"></a>

 ** apiKey **   <a name="appfabric-Type-ApiKeyCredential-apiKey"></a>
An API key for an application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## See Also
<a name="API_ApiKeyCredential_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/ApiKeyCredential) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/ApiKeyCredential) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/ApiKeyCredential) 

# AppAuthorization
<a name="API_AppAuthorization"></a>

Contains information about an app authorization.

## Contents
<a name="API_AppAuthorization_Contents"></a>

 ** app **   <a name="appfabric-Type-AppAuthorization-app"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** appAuthorizationArn **   <a name="appfabric-Type-AppAuthorization-appAuthorizationArn"></a>
The Amazon Resource Name (ARN) of the app authorization.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** appBundleArn **   <a name="appfabric-Type-AppAuthorization-appBundleArn"></a>
The Amazon Resource Name (ARN) of the app bundle for the app authorization.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** authType **   <a name="appfabric-Type-AppAuthorization-authType"></a>
The authorization type.  
Type: String  
Valid Values: `oauth2 | apiKey`   
Required: Yes

 ** createdAt **   <a name="appfabric-Type-AppAuthorization-createdAt"></a>
The timestamp of when the app authorization was created.  
Type: Timestamp  
Required: Yes

 ** status **   <a name="appfabric-Type-AppAuthorization-status"></a>
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.
Type: String  
Valid Values: `PendingConnect | Connected | ConnectionValidationFailed | TokenAutoRotationFailed`   
Required: Yes

 ** tenant **   <a name="appfabric-Type-AppAuthorization-tenant"></a>
Contains information about an application tenant, such as the application display name and identifier.  
Type: [Tenant](API_Tenant.md) object  
Required: Yes

 ** updatedAt **   <a name="appfabric-Type-AppAuthorization-updatedAt"></a>
The timestamp of when the app authorization was last updated.  
Type: Timestamp  
Required: Yes

 ** authUrl **   <a name="appfabric-Type-AppAuthorization-authUrl"></a>
The application URL for the OAuth flow.  
Type: String  
Required: No

 ** persona **   <a name="appfabric-Type-AppAuthorization-persona"></a>
The user persona of the app authorization.  
This field should always be `admin`.  
Type: String  
Valid Values: `admin | endUser`   
Required: No

## See Also
<a name="API_AppAuthorization_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/AppAuthorization) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/AppAuthorization) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/AppAuthorization) 

# AppAuthorizationSummary
<a name="API_AppAuthorizationSummary"></a>

Contains a summary of an app authorization.

## Contents
<a name="API_AppAuthorizationSummary_Contents"></a>

 ** app **   <a name="appfabric-Type-AppAuthorizationSummary-app"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** appAuthorizationArn **   <a name="appfabric-Type-AppAuthorizationSummary-appAuthorizationArn"></a>
The Amazon Resource Name (ARN) of the app authorization.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** appBundleArn **   <a name="appfabric-Type-AppAuthorizationSummary-appBundleArn"></a>
The Amazon Resource Name (ARN) of the app bundle for the app authorization.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** status **   <a name="appfabric-Type-AppAuthorizationSummary-status"></a>
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.
Type: String  
Valid Values: `PendingConnect | Connected | ConnectionValidationFailed | TokenAutoRotationFailed`   
Required: Yes

 ** tenant **   <a name="appfabric-Type-AppAuthorizationSummary-tenant"></a>
Contains information about an application tenant, such as the application display name and identifier.  
Type: [Tenant](API_Tenant.md) object  
Required: Yes

 ** updatedAt **   <a name="appfabric-Type-AppAuthorizationSummary-updatedAt"></a>
Timestamp for when the app authorization was last updated.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_AppAuthorizationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/AppAuthorizationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/AppAuthorizationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/AppAuthorizationSummary) 

# AppBundle
<a name="API_AppBundle"></a>

Contains information about an app bundle.

## Contents
<a name="API_AppBundle_Contents"></a>

 ** arn **   <a name="appfabric-Type-AppBundle-arn"></a>
The Amazon Resource Name (ARN) of the app bundle.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** customerManagedKeyArn **   <a name="appfabric-Type-AppBundle-customerManagedKeyArn"></a>
The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key used to encrypt the application data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: No

## See Also
<a name="API_AppBundle_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/AppBundle) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/AppBundle) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/AppBundle) 

# AppBundleSummary
<a name="API_AppBundleSummary"></a>

Contains a summary of an app bundle.

## Contents
<a name="API_AppBundleSummary_Contents"></a>

 ** arn **   <a name="appfabric-Type-AppBundleSummary-arn"></a>
The Amazon Resource Name (ARN) of the app bundle.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

## See Also
<a name="API_AppBundleSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/AppBundleSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/AppBundleSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/AppBundleSummary) 

# AuditLogDestinationConfiguration
<a name="API_AuditLogDestinationConfiguration"></a>

Contains information about an audit log destination configuration.

## Contents
<a name="API_AuditLogDestinationConfiguration_Contents"></a>

 ** destination **   <a name="appfabric-Type-AuditLogDestinationConfiguration-destination"></a>
Contains information about an audit log destination.  
Type: [Destination](API_Destination.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_AuditLogDestinationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/AuditLogDestinationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/AuditLogDestinationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/AuditLogDestinationConfiguration) 

# AuditLogProcessingConfiguration
<a name="API_AuditLogProcessingConfiguration"></a>

Contains information about an audit log processing configuration.

## Contents
<a name="API_AuditLogProcessingConfiguration_Contents"></a>

 ** format **   <a name="appfabric-Type-AuditLogProcessingConfiguration-format"></a>
The format in which the audit logs need to be formatted.  
Type: String  
Valid Values: `json | parquet`   
Required: Yes

 ** schema **   <a name="appfabric-Type-AuditLogProcessingConfiguration-schema"></a>
The event schema in which the audit logs need to be formatted.  
Type: String  
Valid Values: `ocsf | raw`   
Required: Yes

## See Also
<a name="API_AuditLogProcessingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/AuditLogProcessingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/AuditLogProcessingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/AuditLogProcessingConfiguration) 

# AuthRequest
<a name="API_AuthRequest"></a>

Contains authorization request information, which is required for AWS AppFabric to get the OAuth2 access token for an application.

## Contents
<a name="API_AuthRequest_Contents"></a>

 ** code **   <a name="appfabric-Type-AuthRequest-code"></a>
The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** redirectUri **   <a name="appfabric-Type-AuthRequest-redirectUri"></a>
The redirect URL that is specified in the AuthURL and the application client.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `https://[-a-zA-Z0-9-._~:/?#@!$&'()*+,;=]+`   
Required: Yes

## See Also
<a name="API_AuthRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/AuthRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/AuthRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/AuthRequest) 

# Credential
<a name="API_Credential"></a>

Contains credential information for an application.

## Contents
<a name="API_Credential_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** apiKeyCredential **   <a name="appfabric-Type-Credential-apiKeyCredential"></a>
Contains API key credential information.  
Type: [ApiKeyCredential](API_ApiKeyCredential.md) object  
Required: No

 ** oauth2Credential **   <a name="appfabric-Type-Credential-oauth2Credential"></a>
Contains OAuth2 client credential information.  
Type: [Oauth2Credential](API_Oauth2Credential.md) object  
Required: No

## See Also
<a name="API_Credential_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/Credential) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/Credential) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/Credential) 

# Destination
<a name="API_Destination"></a>

Contains information about an audit log destination.

## Contents
<a name="API_Destination_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** firehoseStream **   <a name="appfabric-Type-Destination-firehoseStream"></a>
Contains information about an Amazon Data Firehose delivery stream.  
Type: [FirehoseStream](API_FirehoseStream.md) object  
Required: No

 ** s3Bucket **   <a name="appfabric-Type-Destination-s3Bucket"></a>
Contains information about an Amazon S3 bucket.  
Type: [S3Bucket](API_S3Bucket.md) object  
Required: No

## See Also
<a name="API_Destination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/Destination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/Destination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/Destination) 

# DestinationConfiguration
<a name="API_DestinationConfiguration"></a>

Contains information about the destination of ingested data.

## Contents
<a name="API_DestinationConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** auditLog **   <a name="appfabric-Type-DestinationConfiguration-auditLog"></a>
Contains information about an audit log destination configuration.  
Type: [AuditLogDestinationConfiguration](API_AuditLogDestinationConfiguration.md) object  
Required: No

## See Also
<a name="API_DestinationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/DestinationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/DestinationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/DestinationConfiguration) 

# FirehoseStream
<a name="API_FirehoseStream"></a>

Contains information about an Amazon Data Firehose delivery stream.

## Contents
<a name="API_FirehoseStream_Contents"></a>

 ** streamName **   <a name="appfabric-Type-FirehoseStream-streamName"></a>
The name of the Amazon Data Firehose delivery stream.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Required: Yes

## See Also
<a name="API_FirehoseStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/FirehoseStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/FirehoseStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/FirehoseStream) 

# Ingestion
<a name="API_Ingestion"></a>

Contains information about an ingestion.

## Contents
<a name="API_Ingestion_Contents"></a>

 ** app **   <a name="appfabric-Type-Ingestion-app"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** appBundleArn **   <a name="appfabric-Type-Ingestion-appBundleArn"></a>
The Amazon Resource Name (ARN) of the app bundle for the ingestion.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** arn **   <a name="appfabric-Type-Ingestion-arn"></a>
The Amazon Resource Name (ARN) of the ingestion.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** createdAt **   <a name="appfabric-Type-Ingestion-createdAt"></a>
The timestamp of when the ingestion was created.  
Type: Timestamp  
Required: Yes

 ** ingestionType **   <a name="appfabric-Type-Ingestion-ingestionType"></a>
The type of the ingestion.  
Type: String  
Valid Values: `auditLog`   
Required: Yes

 ** state **   <a name="appfabric-Type-Ingestion-state"></a>
The status of the ingestion.  
Type: String  
Valid Values: `enabled | disabled`   
Required: Yes

 ** tenantId **   <a name="appfabric-Type-Ingestion-tenantId"></a>
The ID of the application tenant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** updatedAt **   <a name="appfabric-Type-Ingestion-updatedAt"></a>
The timestamp of when the ingestion was last updated.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_Ingestion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/Ingestion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/Ingestion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/Ingestion) 

# IngestionDestination
<a name="API_IngestionDestination"></a>

Contains information about an ingestion destination.

## Contents
<a name="API_IngestionDestination_Contents"></a>

 ** arn **   <a name="appfabric-Type-IngestionDestination-arn"></a>
The Amazon Resource Name (ARN) of the ingestion destination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** destinationConfiguration **   <a name="appfabric-Type-IngestionDestination-destinationConfiguration"></a>
Contains information about the destination of ingested data.  
Type: [DestinationConfiguration](API_DestinationConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** ingestionArn **   <a name="appfabric-Type-IngestionDestination-ingestionArn"></a>
The Amazon Resource Name (ARN) of the ingestion.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** processingConfiguration **   <a name="appfabric-Type-IngestionDestination-processingConfiguration"></a>
Contains information about how ingested data is processed.  
Type: [ProcessingConfiguration](API_ProcessingConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** createdAt **   <a name="appfabric-Type-IngestionDestination-createdAt"></a>
The timestamp of when the ingestion destination was created.  
Type: Timestamp  
Required: No

 ** status **   <a name="appfabric-Type-IngestionDestination-status"></a>
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.
Type: String  
Valid Values: `Active | Failed`   
Required: No

 ** statusReason **   <a name="appfabric-Type-IngestionDestination-statusReason"></a>
The reason for the current status of the ingestion destination.  
Only present when the `status` of ingestion destination is `Failed`.  
Type: String  
Required: No

 ** updatedAt **   <a name="appfabric-Type-IngestionDestination-updatedAt"></a>
The timestamp of when the ingestion destination was last updated.  
Type: Timestamp  
Required: No

## See Also
<a name="API_IngestionDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/IngestionDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/IngestionDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/IngestionDestination) 

# IngestionDestinationSummary
<a name="API_IngestionDestinationSummary"></a>

Contains a summary of an ingestion destination.

## Contents
<a name="API_IngestionDestinationSummary_Contents"></a>

 ** arn **   <a name="appfabric-Type-IngestionDestinationSummary-arn"></a>
The Amazon Resource Name (ARN) of the ingestion destination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

## See Also
<a name="API_IngestionDestinationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/IngestionDestinationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/IngestionDestinationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/IngestionDestinationSummary) 

# IngestionSummary
<a name="API_IngestionSummary"></a>

Contains a summary of an ingestion.

## Contents
<a name="API_IngestionSummary_Contents"></a>

 ** app **   <a name="appfabric-Type-IngestionSummary-app"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** arn **   <a name="appfabric-Type-IngestionSummary-arn"></a>
The Amazon Resource Name (ARN) of the ingestion.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:.+`   
Required: Yes

 ** state **   <a name="appfabric-Type-IngestionSummary-state"></a>
The status of the ingestion.  
Type: String  
Valid Values: `enabled | disabled`   
Required: Yes

 ** tenantId **   <a name="appfabric-Type-IngestionSummary-tenantId"></a>
The ID of the application tenant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

## See Also
<a name="API_IngestionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/IngestionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/IngestionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/IngestionSummary) 

# Oauth2Credential
<a name="API_Oauth2Credential"></a>

Contains OAuth2 client credential information.

## Contents
<a name="API_Oauth2Credential_Contents"></a>

 ** clientId **   <a name="appfabric-Type-Oauth2Credential-clientId"></a>
The client ID of the client application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** clientSecret **   <a name="appfabric-Type-Oauth2Credential-clientSecret"></a>
The client secret of the client application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## See Also
<a name="API_Oauth2Credential_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/Oauth2Credential) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/Oauth2Credential) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/Oauth2Credential) 

# ProcessingConfiguration
<a name="API_ProcessingConfiguration"></a>

Contains information about how ingested data is processed.

## Contents
<a name="API_ProcessingConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** auditLog **   <a name="appfabric-Type-ProcessingConfiguration-auditLog"></a>
Contains information about an audit log processing configuration.  
Type: [AuditLogProcessingConfiguration](API_AuditLogProcessingConfiguration.md) object  
Required: No

## See Also
<a name="API_ProcessingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/ProcessingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/ProcessingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/ProcessingConfiguration) 

# S3Bucket
<a name="API_S3Bucket"></a>

Contains information about an Amazon S3 bucket.

## Contents
<a name="API_S3Bucket_Contents"></a>

 ** bucketName **   <a name="appfabric-Type-S3Bucket-bucketName"></a>
The name of the Amazon S3 bucket.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Required: Yes

 ** prefix **   <a name="appfabric-Type-S3Bucket-prefix"></a>
The object key to use.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 120.  
Required: No

## See Also
<a name="API_S3Bucket_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/S3Bucket) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/S3Bucket) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/S3Bucket) 

# Tag
<a name="API_Tag"></a>

The key or keys of the key-value pairs for the tag or tags assigned to a resource.

## Contents
<a name="API_Tag_Contents"></a>

 ** key **   <a name="appfabric-Type-Tag-key"></a>
Tag key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** value **   <a name="appfabric-Type-Tag-value"></a>
Tag value.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/Tag) 

# TaskError
<a name="API_TaskError"></a>

Contains information about an error returned from a user access task.

## Contents
<a name="API_TaskError_Contents"></a>

 ** errorCode **   <a name="appfabric-Type-TaskError-errorCode"></a>
The code of the error.  
Type: String  
Required: No

 ** errorMessage **   <a name="appfabric-Type-TaskError-errorMessage"></a>
The message of the error.  
Type: String  
Required: No

## See Also
<a name="API_TaskError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/TaskError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/TaskError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/TaskError) 

# Tenant
<a name="API_Tenant"></a>

Contains information about an application tenant.

## Contents
<a name="API_Tenant_Contents"></a>

 ** tenantDisplayName **   <a name="appfabric-Type-Tenant-tenantDisplayName"></a>
The display name of the tenant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** tenantIdentifier **   <a name="appfabric-Type-Tenant-tenantIdentifier"></a>
The ID of the application tenant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

## See Also
<a name="API_Tenant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/Tenant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/Tenant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/Tenant) 

# UserAccessResultItem
<a name="API_UserAccessResultItem"></a>

Contains information about a user's access to an application.

## Contents
<a name="API_UserAccessResultItem_Contents"></a>

 ** app **   <a name="appfabric-Type-UserAccessResultItem-app"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** email **   <a name="appfabric-Type-UserAccessResultItem-email"></a>
The email address of the target user.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 320.  
Pattern: `[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*`   
Required: No

 ** resultStatus **   <a name="appfabric-Type-UserAccessResultItem-resultStatus"></a>
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.
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | FAILED | EXPIRED`   
Required: No

 ** taskError **   <a name="appfabric-Type-UserAccessResultItem-taskError"></a>
Contains information about an error returned from a user access task.  
Type: [TaskError](API_TaskError.md) object  
Required: No

 ** taskId **   <a name="appfabric-Type-UserAccessResultItem-taskId"></a>
The unique ID of the task.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** tenantDisplayName **   <a name="appfabric-Type-UserAccessResultItem-tenantDisplayName"></a>
The display name of the tenant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** tenantId **   <a name="appfabric-Type-UserAccessResultItem-tenantId"></a>
The ID of the application tenant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** userFirstName **   <a name="appfabric-Type-UserAccessResultItem-userFirstName"></a>
The first name of the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** userFullName **   <a name="appfabric-Type-UserAccessResultItem-userFullName"></a>
The full name of the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** userId **   <a name="appfabric-Type-UserAccessResultItem-userId"></a>
The unique ID of user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** userLastName **   <a name="appfabric-Type-UserAccessResultItem-userLastName"></a>
The last name of the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** userStatus **   <a name="appfabric-Type-UserAccessResultItem-userStatus"></a>
The status of the user returned by the application.  
Type: String  
Required: No

## See Also
<a name="API_UserAccessResultItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/UserAccessResultItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/UserAccessResultItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/UserAccessResultItem) 

# UserAccessTaskItem
<a name="API_UserAccessTaskItem"></a>

Contains information about a user access task.

## Contents
<a name="API_UserAccessTaskItem_Contents"></a>

 ** app **   <a name="appfabric-Type-UserAccessTaskItem-app"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** tenantId **   <a name="appfabric-Type-UserAccessTaskItem-tenantId"></a>
The ID of the application tenant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** error **   <a name="appfabric-Type-UserAccessTaskItem-error"></a>
Error from the task, if any.  
Type: [TaskError](API_TaskError.md) object  
Required: No

 ** taskId **   <a name="appfabric-Type-UserAccessTaskItem-taskId"></a>
The unique ID of the task.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

## See Also
<a name="API_UserAccessTaskItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/UserAccessTaskItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/UserAccessTaskItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/UserAccessTaskItem) 

# ValidationExceptionField
<a name="API_ValidationExceptionField"></a>

The input failed to meet the constraints specified by the AWS service in a specified field.

## Contents
<a name="API_ValidationExceptionField_Contents"></a>

 ** message **   <a name="appfabric-Type-ValidationExceptionField-message"></a>
A message about the validation exception.  
Type: String  
Required: Yes

 ** name **   <a name="appfabric-Type-ValidationExceptionField-name"></a>
The field name where the invalid entry was detected.  
Type: String  
Required: Yes

## See Also
<a name="API_ValidationExceptionField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appfabric-2023-05-19/ValidationExceptionField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appfabric-2023-05-19/ValidationExceptionField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appfabric-2023-05-19/ValidationExceptionField) 