Skip to content

CreateIngestionRequest

Source code in docs_src/capo_appfabric/types/create_ingestion_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
class CreateIngestionRequest(TypedDict, closed=True):
    app_bundle_identifier: "capo_appfabric.types.identifier.Identifier"
    """<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>"""
    app: "capo_appfabric.types.string255.String255"
    """<p>The name of the application.</p> <p>Valid values are:</p> <ul> <li> <p> <code>SLACK</code> </p> </li> <li> <p> <code>ASANA</code> </p> </li> <li> <p> <code>JIRA</code> </p> </li> <li> <p> <code>M365</code> </p> </li> <li> <p> <code>M365AUDITLOGS</code> </p> </li> <li> <p> <code>ZOOM</code> </p> </li> <li> <p> <code>ZENDESK</code> </p> </li> <li> <p> <code>OKTA</code> </p> </li> <li> <p> <code>GOOGLE</code> </p> </li> <li> <p> <code>DROPBOX</code> </p> </li> <li> <p> <code>SMARTSHEET</code> </p> </li> <li> <p> <code>CISCO</code> </p> </li> </ul>"""
    tenant_id: "capo_appfabric.types.tenant_identifier.TenantIdentifier"
    """<p>The ID of the application tenant.</p>"""
    ingestion_type: "capo_appfabric.types.ingestion_type.IngestionType"
    """<p>The ingestion type.</p>"""
    client_token: NotRequired["capo_appfabric.types.uuid.UUID"]
    """<p>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 <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>"""
    tags: NotRequired["capo_appfabric.types.tag_list.TagList"]
    """<p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>"""

app instance-attribute 

app: String255

The name of the application.

Valid values are:

  • SLACK

  • ASANA

  • JIRA

  • M365

  • M365AUDITLOGS

  • ZOOM

  • ZENDESK

  • OKTA

  • GOOGLE

  • DROPBOX

  • SMARTSHEET

  • CISCO

app_bundle_identifier instance-attribute 

app_bundle_identifier: Identifier

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

client_token instance-attribute 

client_token: NotRequired[UUID]

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.

ingestion_type instance-attribute 

ingestion_type: IngestionType

The ingestion type.

tags instance-attribute 

tags: NotRequired[TagList]

A map of the key-value pairs of the tag or tags to assign to the resource.

tenant_id instance-attribute 

tenant_id: TenantIdentifier

The ID of the application tenant.