AppFabricClient

Index > AppFabric > AppFabricClient

Auto-generated documentation for AppFabric type annotations stubs module mypy-boto3-appfabric.

AppFabricClient

Type annotations and code completion for boto3.client("appfabric"). boto3 documentation

# AppFabricClient usage example

from boto3.session import Session
from mypy_boto3_appfabric.client import AppFabricClient

def get_appfabric_client() -> AppFabricClient:
    return Session().client("appfabric")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("appfabric").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("appfabric")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_appfabric.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

batch_get_user_access_tasks

Gets user access details in a batch request.

Type annotations and code completion for boto3.client("appfabric").batch_get_user_access_tasks method. boto3 documentation

# batch_get_user_access_tasks method definition

def batch_get_user_access_tasks(
    self,
    *,
    appBundleIdentifier: str,
    taskIdList: Sequence[str],
) -> BatchGetUserAccessTasksResponseTypeDef:  # (1)
    ...

1. See BatchGetUserAccessTasksResponseTypeDef

# batch_get_user_access_tasks method usage example with argument unpacking

kwargs: BatchGetUserAccessTasksRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "taskIdList": ...,
}

parent.batch_get_user_access_tasks(**kwargs)

1. See BatchGetUserAccessTasksRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("appfabric").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("appfabric").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

connect_app_authorization

Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.

Type annotations and code completion for boto3.client("appfabric").connect_app_authorization method. boto3 documentation

# connect_app_authorization method definition

def connect_app_authorization(
    self,
    *,
    appBundleIdentifier: str,
    appAuthorizationIdentifier: str,
    authRequest: AuthRequestTypeDef = ...,  # (1)
) -> ConnectAppAuthorizationResponseTypeDef:  # (2)
    ...

1. See AuthRequestTypeDef
2. See ConnectAppAuthorizationResponseTypeDef

# connect_app_authorization method usage example with argument unpacking

kwargs: ConnectAppAuthorizationRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "appAuthorizationIdentifier": ...,
}

parent.connect_app_authorization(**kwargs)

1. See ConnectAppAuthorizationRequestRequestTypeDef

create_app_authorization

Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.

Type annotations and code completion for boto3.client("appfabric").create_app_authorization method. boto3 documentation

# create_app_authorization method definition

def create_app_authorization(
    self,
    *,
    appBundleIdentifier: str,
    app: str,
    credential: CredentialTypeDef,  # (1)
    tenant: TenantTypeDef,  # (2)
    authType: AuthTypeType,  # (3)
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateAppAuthorizationResponseTypeDef:  # (5)
    ...

1. See CredentialTypeDef
2. See TenantTypeDef
3. See AuthTypeType
4. See TagTypeDef
5. See CreateAppAuthorizationResponseTypeDef

# create_app_authorization method usage example with argument unpacking

kwargs: CreateAppAuthorizationRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "app": ...,
    "credential": ...,
    "tenant": ...,
    "authType": ...,
}

parent.create_app_authorization(**kwargs)

1. See CreateAppAuthorizationRequestRequestTypeDef

create_app_bundle

Creates an app bundle to collect data from an application using AppFabric.

Type annotations and code completion for boto3.client("appfabric").create_app_bundle method. boto3 documentation

# create_app_bundle method definition

def create_app_bundle(
    self,
    *,
    clientToken: str = ...,
    customerManagedKeyIdentifier: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateAppBundleResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateAppBundleResponseTypeDef

# create_app_bundle method usage example with argument unpacking

kwargs: CreateAppBundleRequestRequestTypeDef = {  # (1)
    "clientToken": ...,
}

parent.create_app_bundle(**kwargs)

1. See CreateAppBundleRequestRequestTypeDef

create_ingestion

Creates a data ingestion for an application.

Type annotations and code completion for boto3.client("appfabric").create_ingestion method. boto3 documentation

# create_ingestion method definition

def create_ingestion(
    self,
    *,
    appBundleIdentifier: str,
    app: str,
    tenantId: str,
    ingestionType: IngestionTypeType,  # (1)
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateIngestionResponseTypeDef:  # (3)
    ...

1. See IngestionTypeType
2. See TagTypeDef
3. See CreateIngestionResponseTypeDef

# create_ingestion method usage example with argument unpacking

kwargs: CreateIngestionRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "app": ...,
    "tenantId": ...,
    "ingestionType": ...,
}

parent.create_ingestion(**kwargs)

1. See CreateIngestionRequestRequestTypeDef

create_ingestion_destination

Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

Type annotations and code completion for boto3.client("appfabric").create_ingestion_destination method. boto3 documentation

# create_ingestion_destination method definition

def create_ingestion_destination(
    self,
    *,
    appBundleIdentifier: str,
    ingestionIdentifier: str,
    processingConfiguration: ProcessingConfigurationTypeDef,  # (1)
    destinationConfiguration: DestinationConfigurationTypeDef,  # (2)
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateIngestionDestinationResponseTypeDef:  # (4)
    ...

1. See ProcessingConfigurationTypeDef
2. See DestinationConfigurationTypeDef
3. See TagTypeDef
4. See CreateIngestionDestinationResponseTypeDef

# create_ingestion_destination method usage example with argument unpacking

kwargs: CreateIngestionDestinationRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "ingestionIdentifier": ...,
    "processingConfiguration": ...,
    "destinationConfiguration": ...,
}

parent.create_ingestion_destination(**kwargs)

1. See CreateIngestionDestinationRequestRequestTypeDef

delete_app_authorization

Deletes an app authorization.

Type annotations and code completion for boto3.client("appfabric").delete_app_authorization method. boto3 documentation

# delete_app_authorization method definition

def delete_app_authorization(
    self,
    *,
    appBundleIdentifier: str,
    appAuthorizationIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_app_authorization method usage example with argument unpacking

kwargs: DeleteAppAuthorizationRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "appAuthorizationIdentifier": ...,
}

parent.delete_app_authorization(**kwargs)

1. See DeleteAppAuthorizationRequestRequestTypeDef

delete_app_bundle

Deletes an app bundle.

Type annotations and code completion for boto3.client("appfabric").delete_app_bundle method. boto3 documentation

# delete_app_bundle method definition

def delete_app_bundle(
    self,
    *,
    appBundleIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_app_bundle method usage example with argument unpacking

kwargs: DeleteAppBundleRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
}

parent.delete_app_bundle(**kwargs)

1. See DeleteAppBundleRequestRequestTypeDef

delete_ingestion

Deletes an ingestion.

Type annotations and code completion for boto3.client("appfabric").delete_ingestion method. boto3 documentation

# delete_ingestion method definition

def delete_ingestion(
    self,
    *,
    appBundleIdentifier: str,
    ingestionIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_ingestion method usage example with argument unpacking

kwargs: DeleteIngestionRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "ingestionIdentifier": ...,
}

parent.delete_ingestion(**kwargs)

1. See DeleteIngestionRequestRequestTypeDef

delete_ingestion_destination

Deletes an ingestion destination.

Type annotations and code completion for boto3.client("appfabric").delete_ingestion_destination method. boto3 documentation

# delete_ingestion_destination method definition

def delete_ingestion_destination(
    self,
    *,
    appBundleIdentifier: str,
    ingestionIdentifier: str,
    ingestionDestinationIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_ingestion_destination method usage example with argument unpacking

kwargs: DeleteIngestionDestinationRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "ingestionIdentifier": ...,
    "ingestionDestinationIdentifier": ...,
}

parent.delete_ingestion_destination(**kwargs)

1. See DeleteIngestionDestinationRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("appfabric").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_app_authorization

Returns information about an app authorization.

Type annotations and code completion for boto3.client("appfabric").get_app_authorization method. boto3 documentation

# get_app_authorization method definition

def get_app_authorization(
    self,
    *,
    appBundleIdentifier: str,
    appAuthorizationIdentifier: str,
) -> GetAppAuthorizationResponseTypeDef:  # (1)
    ...

1. See GetAppAuthorizationResponseTypeDef

# get_app_authorization method usage example with argument unpacking

kwargs: GetAppAuthorizationRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "appAuthorizationIdentifier": ...,
}

parent.get_app_authorization(**kwargs)

1. See GetAppAuthorizationRequestRequestTypeDef

get_app_bundle

Returns information about an app bundle.

Type annotations and code completion for boto3.client("appfabric").get_app_bundle method. boto3 documentation

# get_app_bundle method definition

def get_app_bundle(
    self,
    *,
    appBundleIdentifier: str,
) -> GetAppBundleResponseTypeDef:  # (1)
    ...

1. See GetAppBundleResponseTypeDef

# get_app_bundle method usage example with argument unpacking

kwargs: GetAppBundleRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
}

parent.get_app_bundle(**kwargs)

1. See GetAppBundleRequestRequestTypeDef

get_ingestion

Returns information about an ingestion.

Type annotations and code completion for boto3.client("appfabric").get_ingestion method. boto3 documentation

# get_ingestion method definition

def get_ingestion(
    self,
    *,
    appBundleIdentifier: str,
    ingestionIdentifier: str,
) -> GetIngestionResponseTypeDef:  # (1)
    ...

1. See GetIngestionResponseTypeDef

# get_ingestion method usage example with argument unpacking

kwargs: GetIngestionRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "ingestionIdentifier": ...,
}

parent.get_ingestion(**kwargs)

1. See GetIngestionRequestRequestTypeDef

get_ingestion_destination

Returns information about an ingestion destination.

Type annotations and code completion for boto3.client("appfabric").get_ingestion_destination method. boto3 documentation

# get_ingestion_destination method definition

def get_ingestion_destination(
    self,
    *,
    appBundleIdentifier: str,
    ingestionIdentifier: str,
    ingestionDestinationIdentifier: str,
) -> GetIngestionDestinationResponseTypeDef:  # (1)
    ...

1. See GetIngestionDestinationResponseTypeDef

# get_ingestion_destination method usage example with argument unpacking

kwargs: GetIngestionDestinationRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "ingestionIdentifier": ...,
    "ingestionDestinationIdentifier": ...,
}

parent.get_ingestion_destination(**kwargs)

1. See GetIngestionDestinationRequestRequestTypeDef

list_app_authorizations

Returns a list of all app authorizations configured for an app bundle.

Type annotations and code completion for boto3.client("appfabric").list_app_authorizations method. boto3 documentation

# list_app_authorizations method definition

def list_app_authorizations(
    self,
    *,
    appBundleIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAppAuthorizationsResponseTypeDef:  # (1)
    ...

1. See ListAppAuthorizationsResponseTypeDef

# list_app_authorizations method usage example with argument unpacking

kwargs: ListAppAuthorizationsRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
}

parent.list_app_authorizations(**kwargs)

1. See ListAppAuthorizationsRequestRequestTypeDef

list_app_bundles

Returns a list of app bundles.

Type annotations and code completion for boto3.client("appfabric").list_app_bundles method. boto3 documentation

# list_app_bundles method definition

def list_app_bundles(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAppBundlesResponseTypeDef:  # (1)
    ...

1. See ListAppBundlesResponseTypeDef

# list_app_bundles method usage example with argument unpacking

kwargs: ListAppBundlesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_app_bundles(**kwargs)

1. See ListAppBundlesRequestRequestTypeDef

list_ingestion_destinations

Returns a list of all ingestion destinations configured for an ingestion.

Type annotations and code completion for boto3.client("appfabric").list_ingestion_destinations method. boto3 documentation

# list_ingestion_destinations method definition

def list_ingestion_destinations(
    self,
    *,
    appBundleIdentifier: str,
    ingestionIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIngestionDestinationsResponseTypeDef:  # (1)
    ...

1. See ListIngestionDestinationsResponseTypeDef

# list_ingestion_destinations method usage example with argument unpacking

kwargs: ListIngestionDestinationsRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "ingestionIdentifier": ...,
}

parent.list_ingestion_destinations(**kwargs)

1. See ListIngestionDestinationsRequestRequestTypeDef

list_ingestions

Returns a list of all ingestions configured for an app bundle.

Type annotations and code completion for boto3.client("appfabric").list_ingestions method. boto3 documentation

# list_ingestions method definition

def list_ingestions(
    self,
    *,
    appBundleIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIngestionsResponseTypeDef:  # (1)
    ...

1. See ListIngestionsResponseTypeDef

# list_ingestions method usage example with argument unpacking

kwargs: ListIngestionsRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
}

parent.list_ingestions(**kwargs)

1. See ListIngestionsRequestRequestTypeDef

list_tags_for_resource

Returns a list of tags for a resource.

Type annotations and code completion for boto3.client("appfabric").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

start_ingestion

Starts (enables) an ingestion, which collects data from an application.

Type annotations and code completion for boto3.client("appfabric").start_ingestion method. boto3 documentation

# start_ingestion method definition

def start_ingestion(
    self,
    *,
    ingestionIdentifier: str,
    appBundleIdentifier: str,
) -> Dict[str, Any]:
    ...

# start_ingestion method usage example with argument unpacking

kwargs: StartIngestionRequestRequestTypeDef = {  # (1)
    "ingestionIdentifier": ...,
    "appBundleIdentifier": ...,
}

parent.start_ingestion(**kwargs)

1. See StartIngestionRequestRequestTypeDef

start_user_access_tasks

Starts the tasks to search user access status for a specific email address.

Type annotations and code completion for boto3.client("appfabric").start_user_access_tasks method. boto3 documentation

# start_user_access_tasks method definition

def start_user_access_tasks(
    self,
    *,
    appBundleIdentifier: str,
    email: str,
) -> StartUserAccessTasksResponseTypeDef:  # (1)
    ...

1. See StartUserAccessTasksResponseTypeDef

# start_user_access_tasks method usage example with argument unpacking

kwargs: StartUserAccessTasksRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "email": ...,
}

parent.start_user_access_tasks(**kwargs)

1. See StartUserAccessTasksRequestRequestTypeDef

stop_ingestion

Stops (disables) an ingestion.

Type annotations and code completion for boto3.client("appfabric").stop_ingestion method. boto3 documentation

# stop_ingestion method definition

def stop_ingestion(
    self,
    *,
    ingestionIdentifier: str,
    appBundleIdentifier: str,
) -> Dict[str, Any]:
    ...

# stop_ingestion method usage example with argument unpacking

kwargs: StopIngestionRequestRequestTypeDef = {  # (1)
    "ingestionIdentifier": ...,
    "appBundleIdentifier": ...,
}

parent.stop_ingestion(**kwargs)

1. See StopIngestionRequestRequestTypeDef

tag_resource

Assigns one or more tags (key-value pairs) to the specified resource.

Type annotations and code completion for boto3.client("appfabric").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag or tags from a resource.

Type annotations and code completion for boto3.client("appfabric").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_app_authorization

Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.

Type annotations and code completion for boto3.client("appfabric").update_app_authorization method. boto3 documentation

# update_app_authorization method definition

def update_app_authorization(
    self,
    *,
    appBundleIdentifier: str,
    appAuthorizationIdentifier: str,
    credential: CredentialTypeDef = ...,  # (1)
    tenant: TenantTypeDef = ...,  # (2)
) -> UpdateAppAuthorizationResponseTypeDef:  # (3)
    ...

1. See CredentialTypeDef
2. See TenantTypeDef
3. See UpdateAppAuthorizationResponseTypeDef

# update_app_authorization method usage example with argument unpacking

kwargs: UpdateAppAuthorizationRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "appAuthorizationIdentifier": ...,
}

parent.update_app_authorization(**kwargs)

1. See UpdateAppAuthorizationRequestRequestTypeDef

update_ingestion_destination

Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

Type annotations and code completion for boto3.client("appfabric").update_ingestion_destination method. boto3 documentation

# update_ingestion_destination method definition

def update_ingestion_destination(
    self,
    *,
    appBundleIdentifier: str,
    ingestionIdentifier: str,
    ingestionDestinationIdentifier: str,
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
) -> UpdateIngestionDestinationResponseTypeDef:  # (2)
    ...

1. See DestinationConfigurationTypeDef
2. See UpdateIngestionDestinationResponseTypeDef

# update_ingestion_destination method usage example with argument unpacking

kwargs: UpdateIngestionDestinationRequestRequestTypeDef = {  # (1)
    "appBundleIdentifier": ...,
    "ingestionIdentifier": ...,
    "ingestionDestinationIdentifier": ...,
    "destinationConfiguration": ...,
}

parent.update_ingestion_destination(**kwargs)

1. See UpdateIngestionDestinationRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("appfabric").get_paginator method with overloads.

• client.get_paginator("list_app_authorizations") -> ListAppAuthorizationsPaginator
• client.get_paginator("list_app_bundles") -> ListAppBundlesPaginator
• client.get_paginator("list_ingestion_destinations") -> ListIngestionDestinationsPaginator
• client.get_paginator("list_ingestions") -> ListIngestionsPaginator