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