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)
...
# batch_get_user_access_tasks method usage example with argument unpacking
kwargs: BatchGetUserAccessTasksRequestRequestTypeDef = { # (1)
"appBundleIdentifier": ...,
"taskIdList": ...,
}
parent.batch_get_user_access_tasks(**kwargs)
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)
...
# connect_app_authorization method usage example with argument unpacking
kwargs: ConnectAppAuthorizationRequestRequestTypeDef = { # (1)
"appBundleIdentifier": ...,
"appAuthorizationIdentifier": ...,
}
parent.connect_app_authorization(**kwargs)
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)
...
- See CredentialTypeDef
- See TenantTypeDef
- See AuthTypeType
- See TagTypeDef
- See CreateAppAuthorizationResponseTypeDef
# create_app_authorization method usage example with argument unpacking
kwargs: CreateAppAuthorizationRequestRequestTypeDef = { # (1)
"appBundleIdentifier": ...,
"app": ...,
"credential": ...,
"tenant": ...,
"authType": ...,
}
parent.create_app_authorization(**kwargs)
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)
...
# create_app_bundle method usage example with argument unpacking
kwargs: CreateAppBundleRequestRequestTypeDef = { # (1)
"clientToken": ...,
}
parent.create_app_bundle(**kwargs)
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)
...
# create_ingestion method usage example with argument unpacking
kwargs: CreateIngestionRequestRequestTypeDef = { # (1)
"appBundleIdentifier": ...,
"app": ...,
"tenantId": ...,
"ingestionType": ...,
}
parent.create_ingestion(**kwargs)
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)
...
- See ProcessingConfigurationTypeDef
- See DestinationConfigurationTypeDef
- See TagTypeDef
- See CreateIngestionDestinationResponseTypeDef
# create_ingestion_destination method usage example with argument unpacking
kwargs: CreateIngestionDestinationRequestRequestTypeDef = { # (1)
"appBundleIdentifier": ...,
"ingestionIdentifier": ...,
"processingConfiguration": ...,
"destinationConfiguration": ...,
}
parent.create_ingestion_destination(**kwargs)
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)
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)
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)
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)
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)
...
# get_app_authorization method usage example with argument unpacking
kwargs: GetAppAuthorizationRequestRequestTypeDef = { # (1)
"appBundleIdentifier": ...,
"appAuthorizationIdentifier": ...,
}
parent.get_app_authorization(**kwargs)
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)
...
# get_app_bundle method usage example with argument unpacking
kwargs: GetAppBundleRequestRequestTypeDef = { # (1)
"appBundleIdentifier": ...,
}
parent.get_app_bundle(**kwargs)
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)
...
# get_ingestion method usage example with argument unpacking
kwargs: GetIngestionRequestRequestTypeDef = { # (1)
"appBundleIdentifier": ...,
"ingestionIdentifier": ...,
}
parent.get_ingestion(**kwargs)
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)
...