GreengrassV2Client
Index > GreengrassV2 > GreengrassV2Client
Auto-generated documentation for GreengrassV2 type annotations stubs module types-aiobotocore-greengrassv2.
GreengrassV2Client
Type annotations and code completion for session.client("greengrassv2")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_greengrassv2.client import GreengrassV2Client
session = Session()
async with session.client("greengrassv2") as client:
client: GreengrassV2Client
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("greengrassv2").exceptions
structure.
async with session.client("greengrassv2") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.RequestAlreadyInProgressException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_greengrassv2.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
associate_service_role_to_account
Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
Type annotations and code completion for session.client("greengrassv2").associate_service_role_to_account
method.
boto3 documentation
await def associate_service_role_to_account(
self,
*,
roleArn: str,
) -> AssociateServiceRoleToAccountResponseTypeDef: # (1)
...
kwargs: AssociateServiceRoleToAccountRequestRequestTypeDef = { # (1)
"roleArn": ...,
}
parent.associate_service_role_to_account(**kwargs)
batch_associate_client_device_with_core_device
Associates a list of client devices with a core device.
Type annotations and code completion for session.client("greengrassv2").batch_associate_client_device_with_core_device
method.
boto3 documentation
await def batch_associate_client_device_with_core_device(
self,
*,
coreDeviceThingName: str,
entries: Sequence[AssociateClientDeviceWithCoreDeviceEntryTypeDef] = ..., # (1)
) -> BatchAssociateClientDeviceWithCoreDeviceResponseTypeDef: # (2)
...
- See AssociateClientDeviceWithCoreDeviceEntryTypeDef
- See BatchAssociateClientDeviceWithCoreDeviceResponseTypeDef
kwargs: BatchAssociateClientDeviceWithCoreDeviceRequestRequestTypeDef = { # (1)
"coreDeviceThingName": ...,
}
parent.batch_associate_client_device_with_core_device(**kwargs)
batch_disassociate_client_device_from_core_device
Disassociates a list of client devices from a core device.
Type annotations and code completion for session.client("greengrassv2").batch_disassociate_client_device_from_core_device
method.
boto3 documentation
await def batch_disassociate_client_device_from_core_device(
self,
*,
coreDeviceThingName: str,
entries: Sequence[DisassociateClientDeviceFromCoreDeviceEntryTypeDef] = ..., # (1)
) -> BatchDisassociateClientDeviceFromCoreDeviceResponseTypeDef: # (2)
...
- See DisassociateClientDeviceFromCoreDeviceEntryTypeDef
- See BatchDisassociateClientDeviceFromCoreDeviceResponseTypeDef
kwargs: BatchDisassociateClientDeviceFromCoreDeviceRequestRequestTypeDef = { # (1)
"coreDeviceThingName": ...,
}
parent.batch_disassociate_client_device_from_core_device(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("greengrassv2").can_paginate
method.
boto3 documentation
cancel_deployment
Cancels a deployment.
Type annotations and code completion for session.client("greengrassv2").cancel_deployment
method.
boto3 documentation
await def cancel_deployment(
self,
*,
deploymentId: str,
) -> CancelDeploymentResponseTypeDef: # (1)
...
kwargs: CancelDeploymentRequestRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.cancel_deployment(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("greengrassv2").close
method.
boto3 documentation
create_component_version
Creates a component.
Type annotations and code completion for session.client("greengrassv2").create_component_version
method.
boto3 documentation
await def create_component_version(
self,
*,
inlineRecipe: Union[str, bytes, IO[Any], StreamingBody] = ...,
lambdaFunction: LambdaFunctionRecipeSourceTypeDef = ..., # (1)
tags: Mapping[str, str] = ...,
clientToken: str = ...,
) -> CreateComponentVersionResponseTypeDef: # (2)
...
kwargs: CreateComponentVersionRequestRequestTypeDef = { # (1)
"inlineRecipe": ...,
}
parent.create_component_version(**kwargs)
create_deployment
Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices.
Type annotations and code completion for session.client("greengrassv2").create_deployment
method.
boto3 documentation
await def create_deployment(
self,
*,
targetArn: str,
deploymentName: str = ...,
components: Mapping[str, ComponentDeploymentSpecificationTypeDef] = ..., # (1)
iotJobConfiguration: DeploymentIoTJobConfigurationTypeDef = ..., # (2)
deploymentPolicies: DeploymentPoliciesTypeDef = ..., # (3)
tags: Mapping[str, str] = ...,
clientToken: str = ...,
) -> CreateDeploymentResponseTypeDef: # (4)
...
- See ComponentDeploymentSpecificationTypeDef
- See DeploymentIoTJobConfigurationTypeDef
- See DeploymentPoliciesTypeDef
- See CreateDeploymentResponseTypeDef
kwargs: CreateDeploymentRequestRequestTypeDef = { # (1)
"targetArn": ...,
}
parent.create_deployment(**kwargs)
delete_component
Deletes a version of a component from IoT Greengrass.
Type annotations and code completion for session.client("greengrassv2").delete_component
method.
boto3 documentation
await def delete_component(
self,
*,
arn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteComponentRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_component(**kwargs)
delete_core_device
Deletes a Greengrass core device, which is an IoT thing.
Type annotations and code completion for session.client("greengrassv2").delete_core_device
method.
boto3 documentation
await def delete_core_device(
self,
*,
coreDeviceThingName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCoreDeviceRequestRequestTypeDef = { # (1)
"coreDeviceThingName": ...,
}
parent.delete_core_device(**kwargs)
delete_deployment
Deletes a deployment.
Type annotations and code completion for session.client("greengrassv2").delete_deployment
method.
boto3 documentation
await def delete_deployment(
self,
*,
deploymentId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDeploymentRequestRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.delete_deployment(**kwargs)
describe_component
Retrieves metadata for a version of a component.
Type annotations and code completion for session.client("greengrassv2").describe_component
method.
boto3 documentation
await def describe_component(
self,
*,
arn: str,
) -> DescribeComponentResponseTypeDef: # (1)
...
kwargs: DescribeComponentRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.describe_component(**kwargs)
disassociate_service_role_from_account
Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
Type annotations and code completion for session.client("greengrassv2").disassociate_service_role_from_account
method.
boto3 documentation
await def disassociate_service_role_from_account(
self,
) -> DisassociateServiceRoleFromAccountResponseTypeDef: # (1)
...
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("greengrassv2").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_component
Gets the recipe for a version of a component.
Type annotations and code completion for session.client("greengrassv2").get_component
method.
boto3 documentation
await def get_component(
self,
*,
arn: str,
recipeOutputFormat: RecipeOutputFormatType = ..., # (1)
) -> GetComponentResponseTypeDef: # (2)
...
kwargs: GetComponentRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_component(**kwargs)
get_component_version_artifact
Gets the pre-signed URL to download a public or a Lambda component artifact.
Type annotations and code completion for session.client("greengrassv2").get_component_version_artifact
method.
boto3 documentation
await def get_component_version_artifact(
self,
*,
arn: str,
artifactName: str,
) -> GetComponentVersionArtifactResponseTypeDef: # (1)
...
kwargs: GetComponentVersionArtifactRequestRequestTypeDef = { # (1)
"arn": ...,
"artifactName": ...,
}
parent.get_component_version_artifact(**kwargs)
get_connectivity_info
Retrieves connectivity information for a Greengrass core device.
Type annotations and code completion for session.client("greengrassv2").get_connectivity_info
method.
boto3 documentation
await def get_connectivity_info(
self,
*,
thingName: str,
) -> GetConnectivityInfoResponseTypeDef: # (1)
...
kwargs: GetConnectivityInfoRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.get_connectivity_info(**kwargs)
get_core_device
Retrieves metadata for a Greengrass core device.
Type annotations and code completion for session.client("greengrassv2").get_core_device
method.
boto3 documentation
await def get_core_device(
self,
*,
coreDeviceThingName: str,
) -> GetCoreDeviceResponseTypeDef: # (1)
...
kwargs: GetCoreDeviceRequestRequestTypeDef = { # (1)
"coreDeviceThingName": ...,
}
parent.get_core_device(**kwargs)
get_deployment
Gets a deployment.
Type annotations and code completion for session.client("greengrassv2").get_deployment
method.
boto3 documentation
await def get_deployment(
self,
*,
deploymentId: str,
) -> GetDeploymentResponseTypeDef: # (1)
...
kwargs: GetDeploymentRequestRequestTypeDef = { # (1)
"deploymentId": ...,
}
parent.get_deployment(**kwargs)
get_service_role_for_account
Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
Type annotations and code completion for session.client("greengrassv2").get_service_role_for_account
method.
boto3 documentation
await def get_service_role_for_account(
self,
) -> GetServiceRoleForAccountResponseTypeDef: # (1)
...
list_client_devices_associated_with_core_device
Retrieves a paginated list of client devices that are associated with a core device.
Type annotations and code completion for session.client("greengrassv2").list_client_devices_associated_with_core_device
method.
boto3 documentation
await def list_client_devices_associated_with_core_device(
self,
*,
coreDeviceThingName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListClientDevicesAssociatedWithCoreDeviceResponseTypeDef: # (1)
...
kwargs: ListClientDevicesAssociatedWithCoreDeviceRequestRequestTypeDef = { # (1)
"coreDeviceThingName": ...,
}
parent.list_client_devices_associated_with_core_device(**kwargs)
list_component_versions
Retrieves a paginated list of all versions for a component.
Type annotations and code completion for session.client("greengrassv2").list_component_versions
method.
boto3 documentation
await def list_component_versions(
self,
*,
arn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListComponentVersionsResponseTypeDef: # (1)
...
kwargs: ListComponentVersionsRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.list_component_versions(**kwargs)
list_components
Retrieves a paginated list of component summaries.
Type annotations and code completion for session.client("greengrassv2").list_components
method.
boto3 documentation
await def list_components(
self,
*,
scope: ComponentVisibilityScopeType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListComponentsResponseTypeDef: # (2)
...
kwargs: ListComponentsRequestRequestTypeDef = { # (1)
"scope": ...,
}
parent.list_components(**kwargs)
list_core_devices
Retrieves a paginated list of Greengrass core devices.
Type annotations and code completion for session.client("greengrassv2").list_core_devices
method.
boto3 documentation
await def list_core_devices(
self,
*,
thingGroupArn: str = ...,
status: CoreDeviceStatusType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListCoreDevicesResponseTypeDef: # (2)
...
kwargs: ListCoreDevicesRequestRequestTypeDef = { # (1)
"thingGroupArn": ...,
}
parent.list_core_devices(**kwargs)
list_deployments
Retrieves a paginated list of deployments.
Type annotations and code completion for session.client("greengrassv2").list_deployments
method.
boto3 documentation
await def list_deployments(
self,
*,
targetArn: str = ...,
historyFilter: DeploymentHistoryFilterType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListDeploymentsResponseTypeDef: # (2)
...
kwargs: ListDeploymentsRequestRequestTypeDef = { # (1)
"targetArn": ...,
}
parent.list_deployments(**kwargs)
list_effective_deployments
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.
Type annotations and code completion for session.client("greengrassv2").list_effective_deployments
method.
boto3 documentation
await def list_effective_deployments(
self,
*,
coreDeviceThingName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListEffectiveDeploymentsResponseTypeDef: # (1)
...
kwargs: ListEffectiveDeploymentsRequestRequestTypeDef = { # (1)
"coreDeviceThingName": ...,
}
parent.list_effective_deployments(**kwargs)
list_installed_components
Retrieves a paginated list of the components that a Greengrass core device runs.
Type annotations and code completion for session.client("greengrassv2").list_installed_components
method.
boto3 documentation
await def list_installed_components(
self,
*,
coreDeviceThingName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListInstalledComponentsResponseTypeDef: # (1)
...
kwargs: ListInstalledComponentsRequestRequestTypeDef = { # (1)
"coreDeviceThingName": ...,
}
parent.list_installed_components(**kwargs)
list_tags_for_resource
Retrieves the list of tags for an IoT Greengrass resource.
Type annotations and code completion for session.client("greengrassv2").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
resolve_component_candidates
Retrieves a list of components that meet the component, version, and platform requirements of a deployment.
Type annotations and code completion for session.client("greengrassv2").resolve_component_candidates
method.
boto3 documentation
await def resolve_component_candidates(
self,
*,
platform: ComponentPlatformTypeDef = ..., # (1)
componentCandidates: Sequence[ComponentCandidateTypeDef] = ..., # (2)
) -> ResolveComponentCandidatesResponseTypeDef: # (3)
...
- See ComponentPlatformTypeDef
- See ComponentCandidateTypeDef
- See ResolveComponentCandidatesResponseTypeDef
kwargs: ResolveComponentCandidatesRequestRequestTypeDef = { # (1)
"platform": ...,
}
parent.resolve_component_candidates(**kwargs)
tag_resource
Adds tags to an IoT Greengrass resource.
Type annotations and code completion for session.client("greengrassv2").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes a tag from an IoT Greengrass resource.
Type annotations and code completion for session.client("greengrassv2").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_connectivity_info
Updates connectivity information for a Greengrass core device.
Type annotations and code completion for session.client("greengrassv2").update_connectivity_info
method.
boto3 documentation
await def update_connectivity_info(
self,
*,
thingName: str,
connectivityInfo: Sequence[ConnectivityInfoTypeDef], # (1)
) -> UpdateConnectivityInfoResponseTypeDef: # (2)
...
kwargs: UpdateConnectivityInfoRequestRequestTypeDef = { # (1)
"thingName": ...,
"connectivityInfo": ...,
}
parent.update_connectivity_info(**kwargs)
__aenter__
Type annotations and code completion for session.client("greengrassv2").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("greengrassv2").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("greengrassv2").get_paginator
method with overloads.
client.get_paginator("list_client_devices_associated_with_core_device")
-> ListClientDevicesAssociatedWithCoreDevicePaginatorclient.get_paginator("list_component_versions")
-> ListComponentVersionsPaginatorclient.get_paginator("list_components")
-> ListComponentsPaginatorclient.get_paginator("list_core_devices")
-> ListCoreDevicesPaginatorclient.get_paginator("list_deployments")
-> ListDeploymentsPaginatorclient.get_paginator("list_effective_deployments")
-> ListEffectiveDeploymentsPaginatorclient.get_paginator("list_installed_components")
-> ListInstalledComponentsPaginator