Appfabric Classes

ApiKeyCredential

apiKey

• Type:
• Required: Yes

AppAuthorization

appAuthorizationArn

• Type:
• Required: Yes

appBundleArn

• Type:
• Required: Yes

app

• Type:
• Required: Yes

tenant

• Type:
• Required: Yes

authType

• Type: typing.Literal['apiKey', 'oauth2']
• Required: Yes

status

• Type: typing.Literal['Connected', 'ConnectionValidationFailed', 'PendingConnect', 'TokenAutoRotationFailed']
• Required: Yes

createdAt

• Type:
• Required: Yes

updatedAt

• Type:
• Required: Yes

persona

• Type: typing.Optional[typing.Literal['admin', 'endUser']]

authUrl

• Type: typing.Optional[str]

AppAuthorizationSummary

appAuthorizationArn

• Type:
• Required: Yes

appBundleArn

• Type:
• Required: Yes

app

• Type:
• Required: Yes

tenant

• Type:
• Required: Yes

status

• Type: typing.Literal['Connected', 'ConnectionValidationFailed', 'PendingConnect', 'TokenAutoRotationFailed']
• Required: Yes

updatedAt

• Type:
• Required: Yes

AppBundle

arn

• Type:
• Required: Yes

customerManagedKeyArn

• Type: typing.Optional[str]

AppBundleSummary

arn

• Type:
• Required: Yes

AuditLogDestinationConfiguration

destination

• Type:
• Required: Yes

AuditLogProcessingConfiguration

schema

• Type: typing.Literal['ocsf', 'raw']
• Default: >

format

• Type: typing.Literal['json', 'parquet']
• Required: Yes

AuthRequest

redirectUri

• Type:
• Required: Yes

code

• Type:
• Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchGetUserAccessTasksRequest

appBundleIdentifier

• Type:
• Required: Yes

taskIdList

• Type: typing.List[str]
• Required: Yes

BatchGetUserAccessTasksResponse

userAccessResultsList

• Type: typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.UserAccessResultItem]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ConnectAppAuthorizationRequest

appBundleIdentifier

• Type:
• Required: Yes

appAuthorizationIdentifier

• Type:
• Required: Yes

authRequest

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.AuthRequest]

ConnectAppAuthorizationResponse

appAuthorizationSummary

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateAppAuthorizationRequest

appBundleIdentifier

• Type:
• Required: Yes

app

• Type:
• Required: Yes

credential

• Type:
• Required: Yes

tenant

• Type:
• Required: Yes

authType

• Type: typing.Literal['apiKey', 'oauth2']
• Required: Yes

clientToken

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.Tag]]

CreateAppAuthorizationResponse

appAuthorization

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateAppBundleRequest

clientToken

• Type: typing.Optional[str]

customerManagedKeyIdentifier

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.Tag]]

CreateAppBundleResponse

appBundle

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateIngestionDestinationRequest

appBundleIdentifier

• Type:
• Required: Yes

ingestionIdentifier

• Type:
• Required: Yes

processingConfiguration

• Type:
• Required: Yes

destinationConfiguration

• Type:
• Required: Yes

clientToken

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.Tag]]

CreateIngestionDestinationResponse

ingestionDestination

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateIngestionRequest

appBundleIdentifier

• Type:
• Required: Yes

app

• Type:
• Required: Yes

tenantId

• Type:
• Required: Yes

ingestionType

• Type: typing.Literal['auditLog']
• Required: Yes

clientToken

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.Tag]]

CreateIngestionResponse

ingestion

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Credential

oauth2Credential

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.Oauth2Credential]

apiKeyCredential

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.ApiKeyCredential]

DeleteAppAuthorizationRequest

appBundleIdentifier

• Type:
• Required: Yes

appAuthorizationIdentifier

• Type:
• Required: Yes

DeleteAppBundleRequest

appBundleIdentifier

• Type:
• Required: Yes

DeleteIngestionDestinationRequest

appBundleIdentifier

• Type:
• Required: Yes

ingestionIdentifier

• Type:
• Required: Yes

ingestionDestinationIdentifier

• Type:
• Required: Yes

DeleteIngestionRequest

appBundleIdentifier

• Type:
• Required: Yes

ingestionIdentifier

• Type:
• Required: Yes

Destination

s3Bucket

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.S3Bucket]

firehoseStream

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.FirehoseStream]

DestinationConfiguration

auditLog

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.AuditLogDestinationConfiguration]

FirehoseStream

streamName

• Type:
• Required: Yes

GetAppAuthorizationRequest

appBundleIdentifier

• Type:
• Required: Yes

appAuthorizationIdentifier

• Type:
• Required: Yes

GetAppAuthorizationResponse

appAuthorization

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetAppBundleRequest

appBundleIdentifier

• Type:
• Required: Yes

GetAppBundleResponse

appBundle

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetIngestionDestinationRequest

appBundleIdentifier

• Type:
• Required: Yes

ingestionIdentifier

• Type:
• Required: Yes

ingestionDestinationIdentifier

• Type:
• Required: Yes

GetIngestionDestinationResponse

ingestionDestination

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetIngestionRequest

appBundleIdentifier

• Type:
• Required: Yes

ingestionIdentifier

• Type:
• Required: Yes

GetIngestionResponse

ingestion

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Ingestion

arn

• Type:
• Required: Yes

appBundleArn

• Type:
• Required: Yes

app

• Type:
• Required: Yes

tenantId

• Type:
• Required: Yes

createdAt

• Type:
• Required: Yes

updatedAt

• Type:
• Required: Yes

state

• Type: typing.Literal['disabled', 'enabled']
• Required: Yes

ingestionType

• Type: typing.Literal['auditLog']
• Required: Yes

IngestionDestination

arn

• Type:
• Required: Yes

ingestionArn

• Type:
• Required: Yes

processingConfiguration

• Type:
• Required: Yes

destinationConfiguration

• Type:
• Required: Yes

status

• Type: typing.Optional[typing.Literal['Active', 'Failed']]

statusReason

• Type: typing.Optional[str]

createdAt

• Type: typing.Optional[datetime.datetime]

updatedAt

• Type: typing.Optional[datetime.datetime]

IngestionDestinationSummary

arn

• Type:
• Required: Yes

IngestionSummary

arn

• Type:
• Required: Yes

app

• Type:
• Required: Yes

tenantId

• Type:
• Required: Yes

state

• Type: typing.Literal['disabled', 'enabled']
• Required: Yes

ListAppAuthorizationsRequest

appBundleIdentifier

• Type:
• Required: Yes

maxResults

• Type: typing.Optional[int]

nextToken

• Type: typing.Optional[str]

ListAppAuthorizationsRequestPaginate

appBundleIdentifier

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.PaginatorConfig]

ListAppAuthorizationsResponse

appAuthorizationSummaryList

• Type: typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.AppAuthorizationSummary]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

ListAppBundlesRequest

maxResults

• Type: typing.Optional[int]

nextToken

• Type: typing.Optional[str]

ListAppBundlesRequestPaginate

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.PaginatorConfig]

ListAppBundlesResponse

appBundleSummaryList

• Type: typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.AppBundleSummary]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

ListIngestionDestinationsRequest

appBundleIdentifier

• Type:
• Required: Yes

ingestionIdentifier

• Type:
• Required: Yes

maxResults

• Type: typing.Optional[int]

nextToken

• Type: typing.Optional[str]

ListIngestionDestinationsRequestPaginate

appBundleIdentifier

• Type:
• Required: Yes

ingestionIdentifier

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.PaginatorConfig]

ListIngestionDestinationsResponse

ingestionDestinations

• Type: typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.IngestionDestinationSummary]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

ListIngestionsRequest

appBundleIdentifier

• Type:
• Required: Yes

maxResults

• Type: typing.Optional[int]

nextToken

• Type: typing.Optional[str]

ListIngestionsRequestPaginate

appBundleIdentifier

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.PaginatorConfig]

ListIngestionsResponse

ingestions

• Type: typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.IngestionSummary]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

• Type:
• Required: Yes

ListTagsForResourceResponse

tags

• Type: typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.Tag]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Oauth2Credential

clientId

• Type:
• Required: Yes

clientSecret

• Type:
• Required: Yes

PaginatorConfig

MaxItems

• Type: typing.Optional[int]

PageSize

• Type: typing.Optional[int]

StartingToken

• Type: typing.Optional[str]

ProcessingConfiguration

auditLog

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.AuditLogProcessingConfiguration]

ResponseMetadata

RequestId

• Type:
• Required: Yes

HTTPStatusCode

• Type:
• Required: Yes

HTTPHeaders

• Type: typing.Dict[str, str]
• Required: Yes

RetryAttempts

• Type:
• Required: Yes

HostId

• Type: typing.Optional[str]

S3Bucket

bucketName

• Type:
• Required: Yes

prefix

• Type: typing.Optional[str]

StartIngestionRequest

ingestionIdentifier

• Type:
• Required: Yes

appBundleIdentifier

• Type:
• Required: Yes

StartUserAccessTasksRequest

appBundleIdentifier

• Type:
• Required: Yes

email

• Type:
• Required: Yes

StartUserAccessTasksResponse

userAccessTasksList

• Type: typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.UserAccessTaskItem]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

StopIngestionRequest

ingestionIdentifier

• Type:
• Required: Yes

appBundleIdentifier

• Type:
• Required: Yes

Tag

key

• Type:
• Required: Yes

value

• Type:
• Required: Yes

TagResourceRequest

resourceArn

• Type:
• Required: Yes

tags

• Type: typing.List[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.Tag]
• Required: Yes

TaskError

errorCode

• Type: typing.Optional[str]

errorMessage

• Type: typing.Optional[str]

Tenant

tenantIdentifier

• Type:
• Required: Yes

tenantDisplayName

• Type:
• Required: Yes

UntagResourceRequest

resourceArn

• Type:
• Required: Yes

tagKeys

• Type: typing.List[str]
• Required: Yes

UpdateAppAuthorizationRequest

appBundleIdentifier

• Type:
• Required: Yes

appAuthorizationIdentifier

• Type:
• Required: Yes

credential

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.Credential]

tenant

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.Tenant]

UpdateAppAuthorizationResponse

appAuthorization

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UpdateIngestionDestinationRequest

appBundleIdentifier

• Type:
• Required: Yes

ingestionIdentifier

• Type:
• Required: Yes

ingestionDestinationIdentifier

• Type:
• Required: Yes

destinationConfiguration

• Type:
• Required: Yes

UpdateIngestionDestinationResponse

ingestionDestination

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UserAccessResultItem

app

• Type: typing.Optional[str]

tenantId

• Type: typing.Optional[str]

tenantDisplayName

• Type: typing.Optional[str]

taskId

• Type: typing.Optional[str]

resultStatus

• Type: typing.Optional[typing.Literal['COMPLETED', 'EXPIRED', 'FAILED', 'IN_PROGRESS']]

email

• Type: typing.Optional[str]

userId

• Type: typing.Optional[str]

userFullName

• Type: typing.Optional[str]

userFirstName

• Type: typing.Optional[str]

userLastName

• Type: typing.Optional[str]

userStatus

• Type: typing.Optional[str]

taskError

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.TaskError]

UserAccessTaskItem

app

• Type:
• Required: Yes

tenantId

• Type:
• Required: Yes

taskId

• Type: typing.Optional[str]

error

• Type: typing.Optional[aws_resource_validator.pydantic_models.appfabric.appfabric_classes.TaskError]