AppFabric ********* Client ====== class AppFabric.Client A low-level client representing AppFabric 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. import boto3 client = boto3.client('appfabric') These are the available methods: * batch_get_user_access_tasks * can_paginate * close * connect_app_authorization * create_app_authorization * create_app_bundle * create_ingestion * create_ingestion_destination * delete_app_authorization * delete_app_bundle * delete_ingestion * delete_ingestion_destination * get_app_authorization * get_app_bundle * get_ingestion * get_ingestion_destination * get_paginator * get_waiter * list_app_authorizations * list_app_bundles * list_ingestion_destinations * list_ingestions * list_tags_for_resource * start_ingestion * start_user_access_tasks * stop_ingestion * tag_resource * untag_resource * update_app_authorization * update_ingestion_destination Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAppAuthorizations * ListAppBundles * ListIngestionDestinations * ListIngestions AppFabric / Paginator / ListIngestions ListIngestions ************** class AppFabric.Paginator.ListIngestions paginator = client.get_paginator('list_ingestions') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppFabric.Client.list_ingestions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appBundleIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ingestions': [ { 'arn': 'string', 'app': 'string', 'tenantId': 'string', 'state': 'enabled'|'disabled' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ingestions** *(list) --* Contains a list of ingestion summaries. * *(dict) --* Contains a summary of an ingestion. * **arn** *(string) --* The Amazon Resource Name (ARN) of the ingestion. * **app** *(string) --* The name of the application. * **tenantId** *(string) --* The ID of the application tenant. * **state** *(string) --* The status of the ingestion. * **NextToken** *(string) --* A token to resume pagination. AppFabric / Paginator / ListIngestionDestinations ListIngestionDestinations ************************* class AppFabric.Paginator.ListIngestionDestinations paginator = client.get_paginator('list_ingestion_destinations') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppFabric.Client.list_ingestion_destinations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appBundleIdentifier='string', ingestionIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ingestionDestinations': [ { 'arn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ingestionDestinations** *(list) --* Contains a list of ingestion destination summaries. * *(dict) --* Contains a summary of an ingestion destination. * **arn** *(string) --* The Amazon Resource Name (ARN) of the ingestion destination. * **NextToken** *(string) --* A token to resume pagination. AppFabric / Paginator / ListAppAuthorizations ListAppAuthorizations ********************* class AppFabric.Paginator.ListAppAuthorizations paginator = client.get_paginator('list_app_authorizations') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppFabric.Client.list_app_authorizations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( appBundleIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'appAuthorizationSummaryList': [ { 'appAuthorizationArn': 'string', 'appBundleArn': 'string', 'app': 'string', 'tenant': { 'tenantIdentifier': 'string', 'tenantDisplayName': 'string' }, 'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **appAuthorizationSummaryList** *(list) --* Contains a list of app authorization summaries. * *(dict) --* Contains a summary of an app authorization. * **appAuthorizationArn** *(string) --* The Amazon Resource Name (ARN) of the app authorization. * **appBundleArn** *(string) --* The Amazon Resource Name (ARN) of the app bundle for the app authorization. * **app** *(string) --* The name of the application. * **tenant** *(dict) --* Contains information about an application tenant, such as the application display name and identifier. * **tenantIdentifier** *(string) --* The ID of the application tenant. * **tenantDisplayName** *(string) --* The display name of the tenant. * **status** *(string) --* 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. * **updatedAt** *(datetime) --* Timestamp for when the app authorization was last updated. * **NextToken** *(string) --* A token to resume pagination. AppFabric / Paginator / ListAppBundles ListAppBundles ************** class AppFabric.Paginator.ListAppBundles paginator = client.get_paginator('list_app_bundles') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppFabric.Client.list_app_bundles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'appBundleSummaryList': [ { 'arn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **appBundleSummaryList** *(list) --* Contains a list of app bundle summaries. * *(dict) --* Contains a summary of an app bundle. * **arn** *(string) --* The Amazon Resource Name (ARN) of the app bundle. * **NextToken** *(string) --* A token to resume pagination. AppFabric / Client / stop_ingestion stop_ingestion ************** AppFabric.Client.stop_ingestion(**kwargs) Stops (disables) an ingestion. See also: AWS API Documentation **Request Syntax** response = client.stop_ingestion( ingestionIdentifier='string', appBundleIdentifier='string' ) Parameters: * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ConflictException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / get_paginator get_paginator ************* AppFabric.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. AppFabric / Client / get_app_authorization get_app_authorization ********************* AppFabric.Client.get_app_authorization(**kwargs) Returns information about an app authorization. See also: AWS API Documentation **Request Syntax** response = client.get_app_authorization( appBundleIdentifier='string', appAuthorizationIdentifier='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **appAuthorizationIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. Return type: dict Returns: **Response Syntax** { 'appAuthorization': { 'appAuthorizationArn': 'string', 'appBundleArn': 'string', 'app': 'string', 'tenant': { 'tenantIdentifier': 'string', 'tenantDisplayName': 'string' }, 'authType': 'oauth2'|'apiKey', 'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'persona': 'admin'|'endUser', 'authUrl': 'string' } } **Response Structure** * *(dict) --* * **appAuthorization** *(dict) --* Contains information about an app authorization. * **appAuthorizationArn** *(string) --* The Amazon Resource Name (ARN) of the app authorization. * **appBundleArn** *(string) --* The Amazon Resource Name (ARN) of the app bundle for the app authorization. * **app** *(string) --* The name of the application. * **tenant** *(dict) --* Contains information about an application tenant, such as the application display name and identifier. * **tenantIdentifier** *(string) --* The ID of the application tenant. * **tenantDisplayName** *(string) --* The display name of the tenant. * **authType** *(string) --* The authorization type. * **status** *(string) --* 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. * **createdAt** *(datetime) --* The timestamp of when the app authorization was created. * **updatedAt** *(datetime) --* The timestamp of when the app authorization was last updated. * **persona** *(string) --* The user persona of the app authorization. This field should always be "admin". * **authUrl** *(string) --* The application URL for the OAuth flow. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / list_app_authorizations list_app_authorizations *********************** AppFabric.Client.list_app_authorizations(**kwargs) Returns a list of all app authorizations configured for an app bundle. See also: AWS API Documentation **Request Syntax** response = client.list_app_authorizations( appBundleIdentifier='string', maxResults=123, nextToken='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- 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*. Return type: dict Returns: **Response Syntax** { 'appAuthorizationSummaryList': [ { 'appAuthorizationArn': 'string', 'appBundleArn': 'string', 'app': 'string', 'tenant': { 'tenantIdentifier': 'string', 'tenantDisplayName': 'string' }, 'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed', 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **appAuthorizationSummaryList** *(list) --* Contains a list of app authorization summaries. * *(dict) --* Contains a summary of an app authorization. * **appAuthorizationArn** *(string) --* The Amazon Resource Name (ARN) of the app authorization. * **appBundleArn** *(string) --* The Amazon Resource Name (ARN) of the app bundle for the app authorization. * **app** *(string) --* The name of the application. * **tenant** *(dict) --* Contains information about an application tenant, such as the application display name and identifier. * **tenantIdentifier** *(string) --* The ID of the application tenant. * **tenantDisplayName** *(string) --* The display name of the tenant. * **status** *(string) --* 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. * **updatedAt** *(datetime) --* Timestamp for when the app authorization was last updated. * **nextToken** *(string) --* 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*. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / delete_app_authorization delete_app_authorization ************************ AppFabric.Client.delete_app_authorization(**kwargs) Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization. See also: AWS API Documentation **Request Syntax** response = client.delete_app_authorization( appBundleIdentifier='string', appAuthorizationIdentifier='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **appAuthorizationIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / batch_get_user_access_tasks batch_get_user_access_tasks *************************** AppFabric.Client.batch_get_user_access_tasks(**kwargs) Gets user access details in a batch request. This action polls data from the tasks that are kicked off by the "StartUserAccessTasks" action. See also: AWS API Documentation **Request Syntax** response = client.batch_get_user_access_tasks( appBundleIdentifier='string', taskIdList=[ 'string', ] ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **taskIdList** (*list*) -- **[REQUIRED]** The tasks IDs to use for the request. * *(string) --* Return type: dict Returns: **Response Syntax** { 'userAccessResultsList': [ { 'app': 'string', 'tenantId': 'string', 'tenantDisplayName': 'string', 'taskId': 'string', 'resultStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'EXPIRED', 'email': 'string', 'userId': 'string', 'userFullName': 'string', 'userFirstName': 'string', 'userLastName': 'string', 'userStatus': 'string', 'taskError': { 'errorCode': 'string', 'errorMessage': 'string' } }, ] } **Response Structure** * *(dict) --* * **userAccessResultsList** *(list) --* Contains a list of user access results. * *(dict) --* Contains information about a user's access to an application. * **app** *(string) --* The name of the application. * **tenantId** *(string) --* The ID of the application tenant. * **tenantDisplayName** *(string) --* The display name of the tenant. * **taskId** *(string) --* The unique ID of the task. * **resultStatus** *(string) --* 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. * **email** *(string) --* The email address of the target user. * **userId** *(string) --* The unique ID of user. * **userFullName** *(string) --* The full name of the user. * **userFirstName** *(string) --* The first name of the user. * **userLastName** *(string) --* The last name of the user. * **userStatus** *(string) --* The status of the user returned by the application. * **taskError** *(dict) --* Contains information about an error returned from a user access task. * **errorCode** *(string) --* The code of the error. * **errorMessage** *(string) --* The message of the error. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / update_ingestion_destination update_ingestion_destination **************************** AppFabric.Client.update_ingestion_destination(**kwargs) Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered. See also: AWS API Documentation **Request Syntax** response = client.update_ingestion_destination( appBundleIdentifier='string', ingestionIdentifier='string', ingestionDestinationIdentifier='string', destinationConfiguration={ 'auditLog': { 'destination': { 's3Bucket': { 'bucketName': 'string', 'prefix': 'string' }, 'firehoseStream': { 'streamName': 'string' } } } } ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. * **ingestionDestinationIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request. * **destinationConfiguration** (*dict*) -- **[REQUIRED]** Contains information about the destination of ingested data. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "auditLog". * **auditLog** *(dict) --* Contains information about an audit log destination configuration. * **destination** *(dict) --* **[REQUIRED]** Contains information about an audit log destination. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "s3Bucket", "firehoseStream". * **s3Bucket** *(dict) --* Contains information about an Amazon S3 bucket. * **bucketName** *(string) --* **[REQUIRED]** The name of the Amazon S3 bucket. * **prefix** *(string) --* The object key to use. * **firehoseStream** *(dict) --* Contains information about an Amazon Kinesis Data Firehose delivery stream. * **streamName** *(string) --* **[REQUIRED]** The name of the Amazon Kinesis Data Firehose delivery stream. Return type: dict Returns: **Response Syntax** { 'ingestionDestination': { 'arn': 'string', 'ingestionArn': 'string', 'processingConfiguration': { 'auditLog': { 'schema': 'ocsf'|'raw', 'format': 'json'|'parquet' } }, 'destinationConfiguration': { 'auditLog': { 'destination': { 's3Bucket': { 'bucketName': 'string', 'prefix': 'string' }, 'firehoseStream': { 'streamName': 'string' } } } }, 'status': 'Active'|'Failed', 'statusReason': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **ingestionDestination** *(dict) --* Contains information about an ingestion destination. * **arn** *(string) --* The Amazon Resource Name (ARN) of the ingestion destination. * **ingestionArn** *(string) --* The Amazon Resource Name (ARN) of the ingestion. * **processingConfiguration** *(dict) --* Contains information about how ingested data is processed. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "auditLog". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **auditLog** *(dict) --* Contains information about an audit log processing configuration. * **schema** *(string) --* The event schema in which the audit logs need to be formatted. * **format** *(string) --* The format in which the audit logs need to be formatted. * **destinationConfiguration** *(dict) --* Contains information about the destination of ingested data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "auditLog". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **auditLog** *(dict) --* Contains information about an audit log destination configuration. * **destination** *(dict) --* Contains information about an audit log destination. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "s3Bucket", "firehoseStream". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **s3Bucket** *(dict) --* Contains information about an Amazon S3 bucket. * **bucketName** *(string) --* The name of the Amazon S3 bucket. * **prefix** *(string) --* The object key to use. * **firehoseStream** *(dict) --* Contains information about an Amazon Kinesis Data Firehose delivery stream. * **streamName** *(string) --* The name of the Amazon Kinesis Data Firehose delivery stream. * **status** *(string) --* 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. * **statusReason** *(string) --* The reason for the current status of the ingestion destination. Only present when the "status" of ingestion destination is "Failed". * **createdAt** *(datetime) --* The timestamp of when the ingestion destination was created. * **updatedAt** *(datetime) --* The timestamp of when the ingestion destination was last updated. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ServiceQuotaExceededException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ConflictException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / start_ingestion start_ingestion *************** AppFabric.Client.start_ingestion(**kwargs) Starts (enables) an ingestion, which collects data from an application. See also: AWS API Documentation **Request Syntax** response = client.start_ingestion( ingestionIdentifier='string', appBundleIdentifier='string' ) Parameters: * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ConflictException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / can_paginate can_paginate ************ AppFabric.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. AppFabric / Client / create_app_bundle create_app_bundle ***************** AppFabric.Client.create_app_bundle(**kwargs) Creates an app bundle to collect data from an application using AppFabric. See also: AWS API Documentation **Request Syntax** response = client.create_app_bundle( clientToken='string', customerManagedKeyIdentifier='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **customerManagedKeyIdentifier** (*string*) -- 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. * **tags** (*list*) -- A map of the key-value pairs of the tag or tags to assign to the resource. * *(dict) --* The key or keys of the key-value pairs for the tag or tags assigned to a resource. * **key** *(string) --* **[REQUIRED]** Tag key. * **value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'appBundle': { 'arn': 'string', 'customerManagedKeyArn': 'string' } } **Response Structure** * *(dict) --* * **appBundle** *(dict) --* Contains information about an app bundle. * **arn** *(string) --* The Amazon Resource Name (ARN) of the app bundle. * **customerManagedKeyArn** *(string) --* The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the application data. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ServiceQuotaExceededException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ConflictException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / delete_ingestion_destination delete_ingestion_destination **************************** AppFabric.Client.delete_ingestion_destination(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_ingestion_destination( appBundleIdentifier='string', ingestionIdentifier='string', ingestionDestinationIdentifier='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. * **ingestionDestinationIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / get_ingestion get_ingestion ************* AppFabric.Client.get_ingestion(**kwargs) Returns information about an ingestion. See also: AWS API Documentation **Request Syntax** response = client.get_ingestion( appBundleIdentifier='string', ingestionIdentifier='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. Return type: dict Returns: **Response Syntax** { 'ingestion': { 'arn': 'string', 'appBundleArn': 'string', 'app': 'string', 'tenantId': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'state': 'enabled'|'disabled', 'ingestionType': 'auditLog' } } **Response Structure** * *(dict) --* * **ingestion** *(dict) --* Contains information about an ingestion. * **arn** *(string) --* The Amazon Resource Name (ARN) of the ingestion. * **appBundleArn** *(string) --* The Amazon Resource Name (ARN) of the app bundle for the ingestion. * **app** *(string) --* The name of the application. * **tenantId** *(string) --* The ID of the application tenant. * **createdAt** *(datetime) --* The timestamp of when the ingestion was created. * **updatedAt** *(datetime) --* The timestamp of when the ingestion was last updated. * **state** *(string) --* The status of the ingestion. * **ingestionType** *(string) --* The type of the ingestion. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / list_ingestions list_ingestions *************** AppFabric.Client.list_ingestions(**kwargs) Returns a list of all ingestions configured for an app bundle. See also: AWS API Documentation **Request Syntax** response = client.list_ingestions( appBundleIdentifier='string', maxResults=123, nextToken='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- 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*. Return type: dict Returns: **Response Syntax** { 'ingestions': [ { 'arn': 'string', 'app': 'string', 'tenantId': 'string', 'state': 'enabled'|'disabled' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **ingestions** *(list) --* Contains a list of ingestion summaries. * *(dict) --* Contains a summary of an ingestion. * **arn** *(string) --* The Amazon Resource Name (ARN) of the ingestion. * **app** *(string) --* The name of the application. * **tenantId** *(string) --* The ID of the application tenant. * **state** *(string) --* The status of the ingestion. * **nextToken** *(string) --* 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*. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / create_ingestion_destination create_ingestion_destination **************************** AppFabric.Client.create_ingestion_destination(**kwargs) Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered. See also: AWS API Documentation **Request Syntax** response = client.create_ingestion_destination( appBundleIdentifier='string', ingestionIdentifier='string', processingConfiguration={ 'auditLog': { 'schema': 'ocsf'|'raw', 'format': 'json'|'parquet' } }, destinationConfiguration={ 'auditLog': { 'destination': { 's3Bucket': { 'bucketName': 'string', 'prefix': 'string' }, 'firehoseStream': { 'streamName': 'string' } } } }, clientToken='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. * **processingConfiguration** (*dict*) -- **[REQUIRED]** Contains information about how ingested data is processed. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "auditLog". * **auditLog** *(dict) --* Contains information about an audit log processing configuration. * **schema** *(string) --* **[REQUIRED]** The event schema in which the audit logs need to be formatted. * **format** *(string) --* **[REQUIRED]** The format in which the audit logs need to be formatted. * **destinationConfiguration** (*dict*) -- **[REQUIRED]** Contains information about the destination of ingested data. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "auditLog". * **auditLog** *(dict) --* Contains information about an audit log destination configuration. * **destination** *(dict) --* **[REQUIRED]** Contains information about an audit log destination. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "s3Bucket", "firehoseStream". * **s3Bucket** *(dict) --* Contains information about an Amazon S3 bucket. * **bucketName** *(string) --* **[REQUIRED]** The name of the Amazon S3 bucket. * **prefix** *(string) --* The object key to use. * **firehoseStream** *(dict) --* Contains information about an Amazon Kinesis Data Firehose delivery stream. * **streamName** *(string) --* **[REQUIRED]** The name of the Amazon Kinesis Data Firehose delivery stream. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **tags** (*list*) -- A map of the key-value pairs of the tag or tags to assign to the resource. * *(dict) --* The key or keys of the key-value pairs for the tag or tags assigned to a resource. * **key** *(string) --* **[REQUIRED]** Tag key. * **value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'ingestionDestination': { 'arn': 'string', 'ingestionArn': 'string', 'processingConfiguration': { 'auditLog': { 'schema': 'ocsf'|'raw', 'format': 'json'|'parquet' } }, 'destinationConfiguration': { 'auditLog': { 'destination': { 's3Bucket': { 'bucketName': 'string', 'prefix': 'string' }, 'firehoseStream': { 'streamName': 'string' } } } }, 'status': 'Active'|'Failed', 'statusReason': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **ingestionDestination** *(dict) --* Contains information about an ingestion destination. * **arn** *(string) --* The Amazon Resource Name (ARN) of the ingestion destination. * **ingestionArn** *(string) --* The Amazon Resource Name (ARN) of the ingestion. * **processingConfiguration** *(dict) --* Contains information about how ingested data is processed. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "auditLog". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **auditLog** *(dict) --* Contains information about an audit log processing configuration. * **schema** *(string) --* The event schema in which the audit logs need to be formatted. * **format** *(string) --* The format in which the audit logs need to be formatted. * **destinationConfiguration** *(dict) --* Contains information about the destination of ingested data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "auditLog". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **auditLog** *(dict) --* Contains information about an audit log destination configuration. * **destination** *(dict) --* Contains information about an audit log destination. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "s3Bucket", "firehoseStream". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **s3Bucket** *(dict) --* Contains information about an Amazon S3 bucket. * **bucketName** *(string) --* The name of the Amazon S3 bucket. * **prefix** *(string) --* The object key to use. * **firehoseStream** *(dict) --* Contains information about an Amazon Kinesis Data Firehose delivery stream. * **streamName** *(string) --* The name of the Amazon Kinesis Data Firehose delivery stream. * **status** *(string) --* 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. * **statusReason** *(string) --* The reason for the current status of the ingestion destination. Only present when the "status" of ingestion destination is "Failed". * **createdAt** *(datetime) --* The timestamp of when the ingestion destination was created. * **updatedAt** *(datetime) --* The timestamp of when the ingestion destination was last updated. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ServiceQuotaExceededException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ConflictException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / list_tags_for_resource list_tags_for_resource ********************** AppFabric.Client.list_tags_for_resource(**kwargs) Returns a list of tags for a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags. Return type: dict Returns: **Response Syntax** { 'tags': [ { 'key': 'string', 'value': 'string' }, ] } **Response Structure** * *(dict) --* * **tags** *(list) --* A map of the key-value pairs for the tag or tags assigned to the specified resource. * *(dict) --* The key or keys of the key-value pairs for the tag or tags assigned to a resource. * **key** *(string) --* Tag key. * **value** *(string) --* Tag value. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / start_user_access_tasks start_user_access_tasks *********************** AppFabric.Client.start_user_access_tasks(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.start_user_access_tasks( appBundleIdentifier='string', email='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **email** (*string*) -- **[REQUIRED]** The email address of the target user. Return type: dict Returns: **Response Syntax** { 'userAccessTasksList': [ { 'app': 'string', 'tenantId': 'string', 'taskId': 'string', 'error': { 'errorCode': 'string', 'errorMessage': 'string' } }, ] } **Response Structure** * *(dict) --* * **userAccessTasksList** *(list) --* Contains a list of user access task information. * *(dict) --* Contains information about a user access task. * **app** *(string) --* The name of the application. * **tenantId** *(string) --* The ID of the application tenant. * **taskId** *(string) --* The unique ID of the task. * **error** *(dict) --* Error from the task, if any. * **errorCode** *(string) --* The code of the error. * **errorMessage** *(string) --* The message of the error. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / untag_resource untag_resource ************** AppFabric.Client.untag_resource(**kwargs) Removes a tag or tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to untag. * **tagKeys** (*list*) -- **[REQUIRED]** The keys of the key-value pairs for the tag or tags you want to remove from the specified resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / list_app_bundles list_app_bundles **************** AppFabric.Client.list_app_bundles(**kwargs) Returns a list of app bundles. See also: AWS API Documentation **Request Syntax** response = client.list_app_bundles( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- 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*. Return type: dict Returns: **Response Syntax** { 'appBundleSummaryList': [ { 'arn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **appBundleSummaryList** *(list) --* Contains a list of app bundle summaries. * *(dict) --* Contains a summary of an app bundle. * **arn** *(string) --* The Amazon Resource Name (ARN) of the app bundle. * **nextToken** *(string) --* 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*. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / get_waiter get_waiter ********** AppFabric.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" AppFabric / Client / list_ingestion_destinations list_ingestion_destinations *************************** AppFabric.Client.list_ingestion_destinations(**kwargs) Returns a list of all ingestion destinations configured for an ingestion. See also: AWS API Documentation **Request Syntax** response = client.list_ingestion_destinations( appBundleIdentifier='string', ingestionIdentifier='string', maxResults=123, nextToken='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. * **maxResults** (*integer*) -- 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. * **nextToken** (*string*) -- 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*. Return type: dict Returns: **Response Syntax** { 'ingestionDestinations': [ { 'arn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **ingestionDestinations** *(list) --* Contains a list of ingestion destination summaries. * *(dict) --* Contains a summary of an ingestion destination. * **arn** *(string) --* The Amazon Resource Name (ARN) of the ingestion destination. * **nextToken** *(string) --* 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*. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / get_app_bundle get_app_bundle ************** AppFabric.Client.get_app_bundle(**kwargs) Returns information about an app bundle. See also: AWS API Documentation **Request Syntax** response = client.get_app_bundle( appBundleIdentifier='string' ) Parameters: **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. Return type: dict Returns: **Response Syntax** { 'appBundle': { 'arn': 'string', 'customerManagedKeyArn': 'string' } } **Response Structure** * *(dict) --* * **appBundle** *(dict) --* Contains information about an app bundle. * **arn** *(string) --* The Amazon Resource Name (ARN) of the app bundle. * **customerManagedKeyArn** *(string) --* The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the application data. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / delete_ingestion delete_ingestion **************** AppFabric.Client.delete_ingestion(**kwargs) Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion. See also: AWS API Documentation **Request Syntax** response = client.delete_ingestion( appBundleIdentifier='string', ingestionIdentifier='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / get_ingestion_destination get_ingestion_destination ************************* AppFabric.Client.get_ingestion_destination(**kwargs) Returns information about an ingestion destination. See also: AWS API Documentation **Request Syntax** response = client.get_ingestion_destination( appBundleIdentifier='string', ingestionIdentifier='string', ingestionDestinationIdentifier='string' ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **ingestionIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request. * **ingestionDestinationIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request. Return type: dict Returns: **Response Syntax** { 'ingestionDestination': { 'arn': 'string', 'ingestionArn': 'string', 'processingConfiguration': { 'auditLog': { 'schema': 'ocsf'|'raw', 'format': 'json'|'parquet' } }, 'destinationConfiguration': { 'auditLog': { 'destination': { 's3Bucket': { 'bucketName': 'string', 'prefix': 'string' }, 'firehoseStream': { 'streamName': 'string' } } } }, 'status': 'Active'|'Failed', 'statusReason': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **ingestionDestination** *(dict) --* Contains information about an ingestion destination. * **arn** *(string) --* The Amazon Resource Name (ARN) of the ingestion destination. * **ingestionArn** *(string) --* The Amazon Resource Name (ARN) of the ingestion. * **processingConfiguration** *(dict) --* Contains information about how ingested data is processed. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "auditLog". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **auditLog** *(dict) --* Contains information about an audit log processing configuration. * **schema** *(string) --* The event schema in which the audit logs need to be formatted. * **format** *(string) --* The format in which the audit logs need to be formatted. * **destinationConfiguration** *(dict) --* Contains information about the destination of ingested data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "auditLog". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **auditLog** *(dict) --* Contains information about an audit log destination configuration. * **destination** *(dict) --* Contains information about an audit log destination. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "s3Bucket", "firehoseStream". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **s3Bucket** *(dict) --* Contains information about an Amazon S3 bucket. * **bucketName** *(string) --* The name of the Amazon S3 bucket. * **prefix** *(string) --* The object key to use. * **firehoseStream** *(dict) --* Contains information about an Amazon Kinesis Data Firehose delivery stream. * **streamName** *(string) --* The name of the Amazon Kinesis Data Firehose delivery stream. * **status** *(string) --* 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. * **statusReason** *(string) --* The reason for the current status of the ingestion destination. Only present when the "status" of ingestion destination is "Failed". * **createdAt** *(datetime) --* The timestamp of when the ingestion destination was created. * **updatedAt** *(datetime) --* The timestamp of when the ingestion destination was last updated. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / connect_app_authorization connect_app_authorization ************************* AppFabric.Client.connect_app_authorization(**kwargs) Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application. See also: AWS API Documentation **Request Syntax** response = client.connect_app_authorization( appBundleIdentifier='string', appAuthorizationIdentifier='string', authRequest={ 'redirectUri': 'string', 'code': 'string' } ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization to use for the request. * **appAuthorizationIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. * **authRequest** (*dict*) -- Contains OAuth2 authorization information. This is required if the app authorization for the request is configured with an OAuth2 ( "oauth2") authorization type. * **redirectUri** *(string) --* **[REQUIRED]** The redirect URL that is specified in the AuthURL and the application client. * **code** *(string) --* **[REQUIRED]** The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL). Return type: dict Returns: **Response Syntax** { 'appAuthorizationSummary': { 'appAuthorizationArn': 'string', 'appBundleArn': 'string', 'app': 'string', 'tenant': { 'tenantIdentifier': 'string', 'tenantDisplayName': 'string' }, 'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed', 'updatedAt': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **appAuthorizationSummary** *(dict) --* Contains a summary of the app authorization. * **appAuthorizationArn** *(string) --* The Amazon Resource Name (ARN) of the app authorization. * **appBundleArn** *(string) --* The Amazon Resource Name (ARN) of the app bundle for the app authorization. * **app** *(string) --* The name of the application. * **tenant** *(dict) --* Contains information about an application tenant, such as the application display name and identifier. * **tenantIdentifier** *(string) --* The ID of the application tenant. * **tenantDisplayName** *(string) --* The display name of the tenant. * **status** *(string) --* 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. * **updatedAt** *(datetime) --* Timestamp for when the app authorization was last updated. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / close close ***** AppFabric.Client.close() Closes underlying endpoint connections. AppFabric / Client / update_app_authorization update_app_authorization ************************ AppFabric.Client.update_app_authorization(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_app_authorization( appBundleIdentifier='string', appAuthorizationIdentifier='string', credential={ 'oauth2Credential': { 'clientId': 'string', 'clientSecret': 'string' }, 'apiKeyCredential': { 'apiKey': 'string' } }, tenant={ 'tenantIdentifier': 'string', 'tenantDisplayName': 'string' } ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **appAuthorizationIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. * **credential** (*dict*) -- 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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "oauth2Credential", "apiKeyCredential". * **oauth2Credential** *(dict) --* Contains OAuth2 client credential information. * **clientId** *(string) --* **[REQUIRED]** The client ID of the client application. * **clientSecret** *(string) --* **[REQUIRED]** The client secret of the client application. * **apiKeyCredential** *(dict) --* Contains API key credential information. * **apiKey** *(string) --* **[REQUIRED]** An API key for an application. * **tenant** (*dict*) -- Contains information about an application tenant, such as the application display name and identifier. * **tenantIdentifier** *(string) --* **[REQUIRED]** The ID of the application tenant. * **tenantDisplayName** *(string) --* **[REQUIRED]** The display name of the tenant. Return type: dict Returns: **Response Syntax** { 'appAuthorization': { 'appAuthorizationArn': 'string', 'appBundleArn': 'string', 'app': 'string', 'tenant': { 'tenantIdentifier': 'string', 'tenantDisplayName': 'string' }, 'authType': 'oauth2'|'apiKey', 'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'persona': 'admin'|'endUser', 'authUrl': 'string' } } **Response Structure** * *(dict) --* * **appAuthorization** *(dict) --* Contains information about an app authorization. * **appAuthorizationArn** *(string) --* The Amazon Resource Name (ARN) of the app authorization. * **appBundleArn** *(string) --* The Amazon Resource Name (ARN) of the app bundle for the app authorization. * **app** *(string) --* The name of the application. * **tenant** *(dict) --* Contains information about an application tenant, such as the application display name and identifier. * **tenantIdentifier** *(string) --* The ID of the application tenant. * **tenantDisplayName** *(string) --* The display name of the tenant. * **authType** *(string) --* The authorization type. * **status** *(string) --* 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. * **createdAt** *(datetime) --* The timestamp of when the app authorization was created. * **updatedAt** *(datetime) --* The timestamp of when the app authorization was last updated. * **persona** *(string) --* The user persona of the app authorization. This field should always be "admin". * **authUrl** *(string) --* The application URL for the OAuth flow. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / delete_app_bundle delete_app_bundle ***************** AppFabric.Client.delete_app_bundle(**kwargs) Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle. See also: AWS API Documentation **Request Syntax** response = client.delete_app_bundle( appBundleIdentifier='string' ) Parameters: **appBundleIdentifier** (*string*) -- **[REQUIRED]** The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ConflictException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / tag_resource tag_resource ************ AppFabric.Client.tag_resource(**kwargs) Assigns one or more tags (key-value pairs) to the specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to tag. * **tags** (*list*) -- **[REQUIRED]** A map of the key-value pairs of the tag or tags to assign to the resource. * *(dict) --* The key or keys of the key-value pairs for the tag or tags assigned to a resource. * **key** *(string) --* **[REQUIRED]** Tag key. * **value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / create_app_authorization create_app_authorization ************************ AppFabric.Client.create_app_authorization(**kwargs) Creates an app authorization within an app bundle, which allows AppFabric to connect to an application. See also: AWS API Documentation **Request Syntax** response = client.create_app_authorization( appBundleIdentifier='string', app='string', credential={ 'oauth2Credential': { 'clientId': 'string', 'clientSecret': 'string' }, 'apiKeyCredential': { 'apiKey': 'string' } }, tenant={ 'tenantIdentifier': 'string', 'tenantDisplayName': 'string' }, authType='oauth2'|'apiKey', clientToken='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **app** (*string*) -- **[REQUIRED]** The name of the application. Valid values are: * "SLACK" * "ASANA" * "JIRA" * "M365" * "M365AUDITLOGS" * "ZOOM" * "ZENDESK" * "OKTA" * "GOOGLE" * "DROPBOX" * "SMARTSHEET" * "CISCO" * **credential** (*dict*) -- **[REQUIRED]** 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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "oauth2Credential", "apiKeyCredential". * **oauth2Credential** *(dict) --* Contains OAuth2 client credential information. * **clientId** *(string) --* **[REQUIRED]** The client ID of the client application. * **clientSecret** *(string) --* **[REQUIRED]** The client secret of the client application. * **apiKeyCredential** *(dict) --* Contains API key credential information. * **apiKey** *(string) --* **[REQUIRED]** An API key for an application. * **tenant** (*dict*) -- **[REQUIRED]** Contains information about an application tenant, such as the application display name and identifier. * **tenantIdentifier** *(string) --* **[REQUIRED]** The ID of the application tenant. * **tenantDisplayName** *(string) --* **[REQUIRED]** The display name of the tenant. * **authType** (*string*) -- **[REQUIRED]** The authorization type for the app authorization. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **tags** (*list*) -- A map of the key-value pairs of the tag or tags to assign to the resource. * *(dict) --* The key or keys of the key-value pairs for the tag or tags assigned to a resource. * **key** *(string) --* **[REQUIRED]** Tag key. * **value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'appAuthorization': { 'appAuthorizationArn': 'string', 'appBundleArn': 'string', 'app': 'string', 'tenant': { 'tenantIdentifier': 'string', 'tenantDisplayName': 'string' }, 'authType': 'oauth2'|'apiKey', 'status': 'PendingConnect'|'Connected'|'ConnectionValidationFailed'|'TokenAutoRotationFailed', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'persona': 'admin'|'endUser', 'authUrl': 'string' } } **Response Structure** * *(dict) --* * **appAuthorization** *(dict) --* Contains information about an app authorization. * **appAuthorizationArn** *(string) --* The Amazon Resource Name (ARN) of the app authorization. * **appBundleArn** *(string) --* The Amazon Resource Name (ARN) of the app bundle for the app authorization. * **app** *(string) --* The name of the application. * **tenant** *(dict) --* Contains information about an application tenant, such as the application display name and identifier. * **tenantIdentifier** *(string) --* The ID of the application tenant. * **tenantDisplayName** *(string) --* The display name of the tenant. * **authType** *(string) --* The authorization type. * **status** *(string) --* 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. * **createdAt** *(datetime) --* The timestamp of when the app authorization was created. * **updatedAt** *(datetime) --* The timestamp of when the app authorization was last updated. * **persona** *(string) --* The user persona of the app authorization. This field should always be "admin". * **authUrl** *(string) --* The application URL for the OAuth flow. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ServiceQuotaExceededException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ConflictException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.ResourceNotFoundException" * "AppFabric.Client.exceptions.AccessDeniedException" AppFabric / Client / create_ingestion create_ingestion **************** AppFabric.Client.create_ingestion(**kwargs) Creates a data ingestion for an application. See also: AWS API Documentation **Request Syntax** response = client.create_ingestion( appBundleIdentifier='string', app='string', tenantId='string', ingestionType='auditLog', clientToken='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **appBundleIdentifier** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request. * **app** (*string*) -- **[REQUIRED]** The name of the application. Valid values are: * "SLACK" * "ASANA" * "JIRA" * "M365" * "M365AUDITLOGS" * "ZOOM" * "ZENDESK" * "OKTA" * "GOOGLE" * "DROPBOX" * "SMARTSHEET" * "CISCO" * **tenantId** (*string*) -- **[REQUIRED]** The ID of the application tenant. * **ingestionType** (*string*) -- **[REQUIRED]** The ingestion type. * **clientToken** (*string*) -- 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. This field is autopopulated if not provided. * **tags** (*list*) -- A map of the key-value pairs of the tag or tags to assign to the resource. * *(dict) --* The key or keys of the key-value pairs for the tag or tags assigned to a resource. * **key** *(string) --* **[REQUIRED]** Tag key. * **value** *(string) --* **[REQUIRED]** Tag value. Return type: dict Returns: **Response Syntax** { 'ingestion': { 'arn': 'string', 'appBundleArn': 'string', 'app': 'string', 'tenantId': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'state': 'enabled'|'disabled', 'ingestionType': 'auditLog' } } **Response Structure** * *(dict) --* * **ingestion** *(dict) --* Contains information about an ingestion. * **arn** *(string) --* The Amazon Resource Name (ARN) of the ingestion. * **appBundleArn** *(string) --* The Amazon Resource Name (ARN) of the app bundle for the ingestion. * **app** *(string) --* The name of the application. * **tenantId** *(string) --* The ID of the application tenant. * **createdAt** *(datetime) --* The timestamp of when the ingestion was created. * **updatedAt** *(datetime) --* The timestamp of when the ingestion was last updated. * **state** *(string) --* The status of the ingestion. * **ingestionType** *(string) --* The type of the ingestion. **Exceptions** * "AppFabric.Client.exceptions.InternalServerException" * "AppFabric.Client.exceptions.ServiceQuotaExceededException" * "AppFabric.Client.exceptions.ThrottlingException" * "AppFabric.Client.exceptions.ConflictException" * "AppFabric.Client.exceptions.ValidationException" * "AppFabric.Client.exceptions.AccessDeniedException"