GreengrassClient
Index > Greengrass > GreengrassClient
Auto-generated documentation for Greengrass type annotations stubs module mypy-boto3-greengrass.
GreengrassClient
Type annotations and code completion for boto3.client("greengrass")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_greengrass.client import GreengrassClient
def get_greengrass_client() -> GreengrassClient:
return Session().client("greengrass")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("greengrass").exceptions
structure.
client = boto3.client("greengrass")
try:
do_something(client)
except (
client.BadRequestException,
client.ClientError,
client.InternalServerErrorException,
) as e:
print(e)
from mypy_boto3_greengrass.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...
Methods
associate_role_to_group
Associates a role with a group.
Type annotations and code completion for boto3.client("greengrass").associate_role_to_group
method.
boto3 documentation
def associate_role_to_group(
self,
*,
GroupId: str,
RoleArn: str,
) -> AssociateRoleToGroupResponseTypeDef: # (1)
...
kwargs: AssociateRoleToGroupRequestRequestTypeDef = { # (1)
"GroupId": ...,
"RoleArn": ...,
}
parent.associate_role_to_group(**kwargs)
associate_service_role_to_account
Associates a role with your account.
Type annotations and code completion for boto3.client("greengrass").associate_service_role_to_account
method.
boto3 documentation
def associate_service_role_to_account(
self,
*,
RoleArn: str,
) -> AssociateServiceRoleToAccountResponseTypeDef: # (1)
...
kwargs: AssociateServiceRoleToAccountRequestRequestTypeDef = { # (1)
"RoleArn": ...,
}
parent.associate_service_role_to_account(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("greengrass").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("greengrass").close
method.
boto3 documentation
create_connector_definition
Creates a connector definition.
Type annotations and code completion for boto3.client("greengrass").create_connector_definition
method.
boto3 documentation
def create_connector_definition(
self,
*,
AmznClientToken: str = ...,
InitialVersion: ConnectorDefinitionVersionTypeDef = ..., # (1)
Name: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateConnectorDefinitionResponseTypeDef: # (2)
...
kwargs: CreateConnectorDefinitionRequestRequestTypeDef = { # (1)
"AmznClientToken": ...,
}
parent.create_connector_definition(**kwargs)
create_connector_definition_version
Creates a version of a connector definition which has already been defined.
Type annotations and code completion for boto3.client("greengrass").create_connector_definition_version
method.
boto3 documentation
def create_connector_definition_version(
self,
*,
ConnectorDefinitionId: str,
AmznClientToken: str = ...,
Connectors: Sequence[ConnectorTypeDef] = ..., # (1)
) -> CreateConnectorDefinitionVersionResponseTypeDef: # (2)
...
kwargs: CreateConnectorDefinitionVersionRequestRequestTypeDef = { # (1)
"ConnectorDefinitionId": ...,
}
parent.create_connector_definition_version(**kwargs)
create_core_definition
Creates a core definition.
Type annotations and code completion for boto3.client("greengrass").create_core_definition
method.
boto3 documentation
def create_core_definition(
self,
*,
AmznClientToken: str = ...,
InitialVersion: CoreDefinitionVersionTypeDef = ..., # (1)
Name: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateCoreDefinitionResponseTypeDef: # (2)
...
kwargs: CreateCoreDefinitionRequestRequestTypeDef = { # (1)
"AmznClientToken": ...,
}
parent.create_core_definition(**kwargs)
create_core_definition_version
Creates a version of a core definition that has already been defined.
Type annotations and code completion for boto3.client("greengrass").create_core_definition_version
method.
boto3 documentation
def create_core_definition_version(
self,
*,
CoreDefinitionId: str,
AmznClientToken: str = ...,
Cores: Sequence[CoreTypeDef] = ..., # (1)
) -> CreateCoreDefinitionVersionResponseTypeDef: # (2)
...
kwargs: CreateCoreDefinitionVersionRequestRequestTypeDef = { # (1)
"CoreDefinitionId": ...,
}
parent.create_core_definition_version(**kwargs)
create_deployment
Creates a deployment.
Type annotations and code completion for boto3.client("greengrass").create_deployment
method.
boto3 documentation
def create_deployment(
self,
*,
DeploymentType: DeploymentTypeType, # (1)
GroupId: str,
AmznClientToken: str = ...,
DeploymentId: str = ...,
GroupVersionId: str = ...,
) -> CreateDeploymentResponseTypeDef: # (2)
...
kwargs: CreateDeploymentRequestRequestTypeDef = { # (1)
"DeploymentType": ...,
"GroupId": ...,
}
parent.create_deployment(**kwargs)
create_device_definition
Creates a device definition.
Type annotations and code completion for boto3.client("greengrass").create_device_definition
method.
boto3 documentation
def create_device_definition(
self,
*,
AmznClientToken: str = ...,
InitialVersion: DeviceDefinitionVersionTypeDef = ..., # (1)
Name: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateDeviceDefinitionResponseTypeDef: # (2)
...
kwargs: CreateDeviceDefinitionRequestRequestTypeDef = { # (1)
"AmznClientToken": ...,
}
parent.create_device_definition(**kwargs)
create_device_definition_version
Creates a version of a device definition that has already been defined.
Type annotations and code completion for boto3.client("greengrass").create_device_definition_version
method.
boto3 documentation
def create_device_definition_version(
self,
*,
DeviceDefinitionId: str,
AmznClientToken: str = ...,
Devices: Sequence[DeviceTypeDef] = ..., # (1)
) -> CreateDeviceDefinitionVersionResponseTypeDef: # (2)
...
kwargs: CreateDeviceDefinitionVersionRequestRequestTypeDef = { # (1)
"DeviceDefinitionId": ...,
}
parent.create_device_definition_version(**kwargs)
create_function_definition
Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group.
Type annotations and code completion for boto3.client("greengrass").create_function_definition
method.
boto3 documentation
def create_function_definition(
self,
*,
AmznClientToken: str = ...,
InitialVersion: FunctionDefinitionVersionTypeDef = ..., # (1)
Name: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateFunctionDefinitionResponseTypeDef: # (2)
...
kwargs: CreateFunctionDefinitionRequestRequestTypeDef = { # (1)
"AmznClientToken": ...,
}
parent.create_function_definition(**kwargs)
create_function_definition_version
Creates a version of a Lambda function definition that has already been defined.
Type annotations and code completion for boto3.client("greengrass").create_function_definition_version
method.
boto3 documentation
def create_function_definition_version(
self,
*,
FunctionDefinitionId: str,
AmznClientToken: str = ...,
DefaultConfig: FunctionDefaultConfigTypeDef = ..., # (1)
Functions: Sequence[FunctionTypeDef] = ..., # (2)
) -> CreateFunctionDefinitionVersionResponseTypeDef: # (3)
...
- See FunctionDefaultConfigTypeDef
- See FunctionTypeDef
- See CreateFunctionDefinitionVersionResponseTypeDef
kwargs: CreateFunctionDefinitionVersionRequestRequestTypeDef = { # (1)
"FunctionDefinitionId": ...,
}
parent.create_function_definition_version(**kwargs)
create_group
Creates a group.
Type annotations and code completion for boto3.client("greengrass").create_group
method.
boto3 documentation
def create_group(
self,
*,
Name: str,
AmznClientToken: str = ...,
InitialVersion: GroupVersionTypeDef = ..., # (1)
tags: Mapping[str, str] = ...,
) -> CreateGroupResponseTypeDef: # (2)
...
kwargs: CreateGroupRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_group(**kwargs)
create_group_certificate_authority
Creates a CA for the group.
Type annotations and code completion for boto3.client("greengrass").create_group_certificate_authority
method.
boto3 documentation
def create_group_certificate_authority(
self,
*,
GroupId: str,
AmznClientToken: str = ...,
) -> CreateGroupCertificateAuthorityResponseTypeDef: # (1)
...
kwargs: CreateGroupCertificateAuthorityRequestRequestTypeDef = { # (1)
"GroupId": ...,
}
parent.create_group_certificate_authority(**kwargs)
create_group_version
Creates a version of a group which has already been defined.
Type annotations and code completion for boto3.client("greengrass").create_group_version
method.
boto3 documentation
def create_group_version(
self,
*,
GroupId: str,
AmznClientToken: str = ...,
ConnectorDefinitionVersionArn: str = ...,
CoreDefinitionVersionArn: str = ...,
DeviceDefinitionVersionArn: str = ...,
FunctionDefinitionVersionArn: str = ...,
LoggerDefinitionVersionArn: str = ...,
ResourceDefinitionVersionArn: str = ...,
SubscriptionDefinitionVersionArn: str = ...,
) -> CreateGroupVersionResponseTypeDef: # (1)
...
kwargs: CreateGroupVersionRequestRequestTypeDef = { # (1)
"GroupId": ...,
}
parent.create_group_version(**kwargs)
create_logger_definition
Creates a logger definition.
Type annotations and code completion for boto3.client("greengrass").create_logger_definition
method.
boto3 documentation
def create_logger_definition(
self,
*,
AmznClientToken: str = ...,
InitialVersion: LoggerDefinitionVersionTypeDef = ..., # (1)
Name: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateLoggerDefinitionResponseTypeDef: # (2)
...
kwargs: CreateLoggerDefinitionRequestRequestTypeDef = { # (1)
"AmznClientToken": ...,
}
parent.create_logger_definition(**kwargs)
create_logger_definition_version
Creates a version of a logger definition that has already been defined.
Type annotations and code completion for boto3.client("greengrass").create_logger_definition_version
method.
boto3 documentation
def create_logger_definition_version(
self,
*,
LoggerDefinitionId: str,
AmznClientToken: str = ...,
Loggers: Sequence[LoggerTypeDef] = ..., # (1)
) -> CreateLoggerDefinitionVersionResponseTypeDef: # (2)
...
kwargs: CreateLoggerDefinitionVersionRequestRequestTypeDef = { # (1)
"LoggerDefinitionId": ...,
}
parent.create_logger_definition_version(**kwargs)
create_resource_definition
Creates a resource definition which contains a list of resources to be used in a group.
Type annotations and code completion for boto3.client("greengrass").create_resource_definition
method.
boto3 documentation
def create_resource_definition(
self,
*,
AmznClientToken: str = ...,
InitialVersion: ResourceDefinitionVersionTypeDef = ..., # (1)
Name: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateResourceDefinitionResponseTypeDef: # (2)
...
kwargs: CreateResourceDefinitionRequestRequestTypeDef = { # (1)
"AmznClientToken": ...,
}
parent.create_resource_definition(**kwargs)
create_resource_definition_version
Creates a version of a resource definition that has already been defined.
Type annotations and code completion for boto3.client("greengrass").create_resource_definition_version
method.
boto3 documentation
def create_resource_definition_version(
self,
*,
ResourceDefinitionId: str,
AmznClientToken: str = ...,
Resources: Sequence[ResourceTypeDef] = ..., # (1)
) -> CreateResourceDefinitionVersionResponseTypeDef: # (2)
...
kwargs: CreateResourceDefinitionVersionRequestRequestTypeDef = { # (1)
"ResourceDefinitionId": ...,
}
parent.create_resource_definition_version(**kwargs)
create_software_update_job
Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software.
Type annotations and code completion for boto3.client("greengrass").create_software_update_job
method.
boto3 documentation
def create_software_update_job(
self,
*,
S3UrlSignerRole: str,
SoftwareToUpdate: SoftwareToUpdateType, # (1)
UpdateTargets: Sequence[str],
UpdateTargetsArchitecture: UpdateTargetsArchitectureType, # (2)
UpdateTargetsOperatingSystem: UpdateTargetsOperatingSystemType, # (3)
AmznClientToken: str = ...,
UpdateAgentLogLevel: UpdateAgentLogLevelType = ..., # (4)
) -> CreateSoftwareUpdateJobResponseTypeDef: # (5)
...
- See SoftwareToUpdateType
- See UpdateTargetsArchitectureType
- See UpdateTargetsOperatingSystemType
- See UpdateAgentLogLevelType
- See CreateSoftwareUpdateJobResponseTypeDef
kwargs: CreateSoftwareUpdateJobRequestRequestTypeDef = { # (1)
"S3UrlSignerRole": ...,
"SoftwareToUpdate": ...,
"UpdateTargets": ...,
"UpdateTargetsArchitecture": ...,
"UpdateTargetsOperatingSystem": ...,
}
parent.create_software_update_job(**kwargs)
create_subscription_definition
Creates a subscription definition.
Type annotations and code completion for boto3.client("greengrass").create_subscription_definition
method.
boto3 documentation
def create_subscription_definition(
self,
*,
AmznClientToken: str = ...,
InitialVersion: SubscriptionDefinitionVersionTypeDef = ..., # (1)
Name: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateSubscriptionDefinitionResponseTypeDef: # (2)
...
kwargs: CreateSubscriptionDefinitionRequestRequestTypeDef = { # (1)
"AmznClientToken": ...,
}
parent.create_subscription_definition(**kwargs)
create_subscription_definition_version
Creates a version of a subscription definition which has already been defined.
Type annotations and code completion for boto3.client("greengrass").create_subscription_definition_version
method.
boto3 documentation
def create_subscription_definition_version(
self,
*,
SubscriptionDefinitionId: str,
AmznClientToken: str = ...,
Subscriptions: Sequence[SubscriptionTypeDef] = ..., # (1)
) -> CreateSubscriptionDefinitionVersionResponseTypeDef: # (2)
...
kwargs: CreateSubscriptionDefinitionVersionRequestRequestTypeDef = { # (1)
"SubscriptionDefinitionId": ...,
}
parent.create_subscription_definition_version(**kwargs)
delete_connector_definition
Deletes a connector definition.
Type annotations and code completion for boto3.client("greengrass").delete_connector_definition
method.
boto3 documentation
def delete_connector_definition(
self,
*,
ConnectorDefinitionId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteConnectorDefinitionRequestRequestTypeDef = { # (1)
"ConnectorDefinitionId": ...,
}
parent.delete_connector_definition(**kwargs)
delete_core_definition
Deletes a core definition.
Type annotations and code completion for boto3.client("greengrass").delete_core_definition
method.
boto3 documentation
def delete_core_definition(
self,
*,
CoreDefinitionId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteCoreDefinitionRequestRequestTypeDef = { # (1)
"CoreDefinitionId": ...,
}
parent.delete_core_definition(**kwargs)
delete_device_definition
Deletes a device definition.
Type annotations and code completion for boto3.client("greengrass").delete_device_definition
method.
boto3 documentation
def delete_device_definition(
self,
*,
DeviceDefinitionId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteDeviceDefinitionRequestRequestTypeDef = { # (1)
"DeviceDefinitionId": ...,
}
parent.delete_device_definition(**kwargs)
delete_function_definition
Deletes a Lambda function definition.
Type annotations and code completion for boto3.client("greengrass").delete_function_definition
method.
boto3 documentation
def delete_function_definition(
self,
*,
FunctionDefinitionId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteFunctionDefinitionRequestRequestTypeDef = { # (1)
"FunctionDefinitionId": ...,
}
parent.delete_function_definition(**kwargs)
delete_group
Deletes a group.
Type annotations and code completion for boto3.client("greengrass").delete_group
method.
boto3 documentation
kwargs: DeleteGroupRequestRequestTypeDef = { # (1)
"GroupId": ...,
}
parent.delete_group(**kwargs)
delete_logger_definition
Deletes a logger definition.
Type annotations and code completion for boto3.client("greengrass").delete_logger_definition
method.
boto3 documentation
def delete_logger_definition(
self,
*,
LoggerDefinitionId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteLoggerDefinitionRequestRequestTypeDef = { # (1)
"LoggerDefinitionId": ...,
}
parent.delete_logger_definition(**kwargs)
delete_resource_definition
Deletes a resource definition.
Type annotations and code completion for boto3.client("greengrass").delete_resource_definition
method.
boto3 documentation
def delete_resource_definition(
self,
*,
ResourceDefinitionId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteResourceDefinitionRequestRequestTypeDef = { # (1)
"ResourceDefinitionId": ...,
}
parent.delete_resource_definition(**kwargs)
delete_subscription_definition
Deletes a subscription definition.
Type annotations and code completion for boto3.client("greengrass").delete_subscription_definition
method.
boto3 documentation
def delete_subscription_definition(
self,
*,
SubscriptionDefinitionId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteSubscriptionDefinitionRequestRequestTypeDef = { # (1)
"SubscriptionDefinitionId": ...,
}
parent.delete_subscription_definition(**kwargs)
disassociate_role_from_group
Disassociates the role from a group.
Type annotations and code completion for boto3.client("greengrass").disassociate_role_from_group
method.
boto3 documentation
def disassociate_role_from_group(
self,
*,
GroupId: str,
) -> DisassociateRoleFromGroupResponseTypeDef: # (1)
...
kwargs: DisassociateRoleFromGroupRequestRequestTypeDef = { # (1)
"GroupId": ...,
}
parent.disassociate_role_from_group(**kwargs)
disassociate_service_role_from_account
Disassociates the service role from your account.
Type annotations and code completion for boto3.client("greengrass").disassociate_service_role_from_account
method.
boto3 documentation
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 boto3.client("greengrass").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_associated_role
Retrieves the role associated with a particular group.
Type annotations and code completion for boto3.client("greengrass").get_associated_role
method.
boto3 documentation
def get_associated_role(
self,
*,
GroupId: str,
) -> GetAssociatedRoleResponseTypeDef: # (1)
...
kwargs: GetAssociatedRoleRequestRequestTypeDef = { # (1)
"GroupId": ...,
}
parent.get_associated_role(**kwargs)
get_bulk_deployment_status
Returns the status of a bulk deployment.
Type annotations and code completion for boto3.client("greengrass").get_bulk_deployment_status
method.
boto3 documentation
def get_bulk_deployment_status(
self,
*,
BulkDeploymentId: str,
) -> GetBulkDeploymentStatusResponseTypeDef: # (1)
...
kwargs: GetBulkDeploymentStatusRequestRequestTypeDef = { # (1)
"BulkDeploymentId": ...,
}
parent.get_bulk_deployment_status(**kwargs)
get_connectivity_info
Retrieves the connectivity information for a core.
Type annotations and code completion for boto3.client("greengrass").get_connectivity_info
method.
boto3 documentation
def get_connectivity_info(
self,
*,
ThingName: str,
) -> GetConnectivityInfoResponseTypeDef: # (1)
...
kwargs: GetConnectivityInfoRequestRequestTypeDef = { # (1)
"ThingName": ...,
}
parent.get_connectivity_info(**kwargs)
get_connector_definition
Retrieves information about a connector definition.
Type annotations and code completion for boto3.client("greengrass").get_connector_definition
method.
boto3 documentation
def get_connector_definition(
self,
*,
ConnectorDefinitionId: str,
) -> GetConnectorDefinitionResponseTypeDef: # (1)
...
kwargs: GetConnectorDefinitionRequestRequestTypeDef = { # (1)
"ConnectorDefinitionId": ...,
}
parent.get_connector_definition(**kwargs)
get_connector_definition_version
Retrieves information about a connector definition version, including the connectors that the version contains.
Type annotations and code completion for boto3.client("greengrass").get_connector_definition_version
method.
boto3 documentation
def get_connector_definition_version(
self,
*,
ConnectorDefinitionId: str,
ConnectorDefinitionVersionId: str,
NextToken: str = ...,
) -> GetConnectorDefinitionVersionResponseTypeDef: # (1)
...
kwargs: GetConnectorDefinitionVersionRequestRequestTypeDef = { # (1)
"ConnectorDefinitionId": ...,
"ConnectorDefinitionVersionId": ...,
}
parent.get_connector_definition_version(**kwargs)
get_core_definition
Retrieves information about a core definition version.
Type annotations and code completion for boto3.client("greengrass").get_core_definition
method.
boto3 documentation
def get_core_definition(
self,
*,
CoreDefinitionId: str,
) -> GetCoreDefinitionResponseTypeDef: # (1)
...
kwargs: GetCoreDefinitionRequestRequestTypeDef = { # (1)
"CoreDefinitionId": ...,
}
parent.get_core_definition(**kwargs)
get_core_definition_version
Retrieves information about a core definition version.
Type annotations and code completion for boto3.client("greengrass").get_core_definition_version
method.
boto3 documentation
def get_core_definition_version(
self,
*,
CoreDefinitionId: str,
CoreDefinitionVersionId: str,
) -> GetCoreDefinitionVersionResponseTypeDef: # (1)
...
kwargs: GetCoreDefinitionVersionRequestRequestTypeDef = { # (1)
"CoreDefinitionId": ...,
"CoreDefinitionVersionId": ...,
}
parent.get_core_definition_version(**kwargs)
get_deployment_status
Returns the status of a deployment.
Type annotations and code completion for boto3.client("greengrass").get_deployment_status
method.
boto3 documentation
def get_deployment_status(
self,
*,
DeploymentId: str,
GroupId: str,
) -> GetDeploymentStatusResponseTypeDef: # (1)
...
kwargs: GetDeploymentStatusRequestRequestTypeDef = { # (1)
"DeploymentId": ...,
"GroupId": ...,
}
parent.get_deployment_status(**kwargs)
get_device_definition
Retrieves information about a device definition.
Type annotations and code completion for boto3.client("greengrass").get_device_definition
method.
boto3 documentation
def get_device_definition(
self,
*,
DeviceDefinitionId: str,
) -> GetDeviceDefinitionResponseTypeDef: # (1)
...
kwargs: GetDeviceDefinitionRequestRequestTypeDef = { # (1)
"DeviceDefinitionId": ...,
}
parent.get_device_definition(**kwargs)
get_device_definition_version
Retrieves information about a device definition version.
Type annotations and code completion for boto3.client("greengrass").get_device_definition_version
method.
boto3 documentation
def get_device_definition_version(
self,
*,
DeviceDefinitionId: str,
DeviceDefinitionVersionId: str,
NextToken: str = ...,
) -> GetDeviceDefinitionVersionResponseTypeDef: # (1)
...
kwargs: GetDeviceDefinitionVersionRequestRequestTypeDef = { # (1)
"DeviceDefinitionId": ...,
"DeviceDefinitionVersionId": ...,
}
parent.get_device_definition_version(**kwargs)
get_function_definition
Retrieves information about a Lambda function definition, including its creation time and latest version.
Type annotations and code completion for boto3.client("greengrass").get_function_definition
method.
boto3 documentation
def get_function_definition(
self,
*,
FunctionDefinitionId: str,
) -> GetFunctionDefinitionResponseTypeDef: # (1)
...
kwargs: GetFunctionDefinitionRequestRequestTypeDef = { # (1)
"FunctionDefinitionId": ...,
}
parent.get_function_definition(**kwargs)
get_function_definition_version
Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.
Type annotations