Skip to content

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

Usage example
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.

Usage example
client = boto3.client("greengrass")

try:
    do_something(client)
except (
    client.BadRequestException,
    client.ClientError,
    client.InternalServerErrorException,
) as e:
    print(e)
Type checking example
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

Method definition
def associate_role_to_group(
    self,
    *,
    GroupId: str,
    RoleArn: str,
) -> AssociateRoleToGroupResponseTypeDef:  # (1)
    ...
  1. See AssociateRoleToGroupResponseTypeDef
Usage example with kwargs
kwargs: AssociateRoleToGroupRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
    "RoleArn": ...,
}

parent.associate_role_to_group(**kwargs)
  1. See AssociateRoleToGroupRequestRequestTypeDef

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

Method definition
def associate_service_role_to_account(
    self,
    *,
    RoleArn: str,
) -> AssociateServiceRoleToAccountResponseTypeDef:  # (1)
    ...
  1. See AssociateServiceRoleToAccountResponseTypeDef
Usage example with kwargs
kwargs: AssociateServiceRoleToAccountRequestRequestTypeDef = {  # (1)
    "RoleArn": ...,
}

parent.associate_service_role_to_account(**kwargs)
  1. See AssociateServiceRoleToAccountRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

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

create_connector_definition

Creates a connector definition.

Type annotations and code completion for boto3.client("greengrass").create_connector_definition method. boto3 documentation

Method definition
def create_connector_definition(
    self,
    *,
    AmznClientToken: str = ...,
    InitialVersion: ConnectorDefinitionVersionTypeDef = ...,  # (1)
    Name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateConnectorDefinitionResponseTypeDef:  # (2)
    ...
  1. See ConnectorDefinitionVersionTypeDef
  2. See CreateConnectorDefinitionResponseTypeDef
Usage example with kwargs
kwargs: CreateConnectorDefinitionRequestRequestTypeDef = {  # (1)
    "AmznClientToken": ...,
}

parent.create_connector_definition(**kwargs)
  1. See CreateConnectorDefinitionRequestRequestTypeDef

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

Method definition
def create_connector_definition_version(
    self,
    *,
    ConnectorDefinitionId: str,
    AmznClientToken: str = ...,
    Connectors: Sequence[ConnectorTypeDef] = ...,  # (1)
) -> CreateConnectorDefinitionVersionResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeDef
  2. See CreateConnectorDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateConnectorDefinitionVersionRequestRequestTypeDef = {  # (1)
    "ConnectorDefinitionId": ...,
}

parent.create_connector_definition_version(**kwargs)
  1. See CreateConnectorDefinitionVersionRequestRequestTypeDef

create_core_definition

Creates a core definition.

Type annotations and code completion for boto3.client("greengrass").create_core_definition method. boto3 documentation

Method definition
def create_core_definition(
    self,
    *,
    AmznClientToken: str = ...,
    InitialVersion: CoreDefinitionVersionTypeDef = ...,  # (1)
    Name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateCoreDefinitionResponseTypeDef:  # (2)
    ...
  1. See CoreDefinitionVersionTypeDef
  2. See CreateCoreDefinitionResponseTypeDef
Usage example with kwargs
kwargs: CreateCoreDefinitionRequestRequestTypeDef = {  # (1)
    "AmznClientToken": ...,
}

parent.create_core_definition(**kwargs)
  1. See CreateCoreDefinitionRequestRequestTypeDef

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

Method definition
def create_core_definition_version(
    self,
    *,
    CoreDefinitionId: str,
    AmznClientToken: str = ...,
    Cores: Sequence[CoreTypeDef] = ...,  # (1)
) -> CreateCoreDefinitionVersionResponseTypeDef:  # (2)
    ...
  1. See CoreTypeDef
  2. See CreateCoreDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateCoreDefinitionVersionRequestRequestTypeDef = {  # (1)
    "CoreDefinitionId": ...,
}

parent.create_core_definition_version(**kwargs)
  1. See CreateCoreDefinitionVersionRequestRequestTypeDef

create_deployment

Creates a deployment.

Type annotations and code completion for boto3.client("greengrass").create_deployment method. boto3 documentation

Method definition
def create_deployment(
    self,
    *,
    DeploymentType: DeploymentTypeType,  # (1)
    GroupId: str,
    AmznClientToken: str = ...,
    DeploymentId: str = ...,
    GroupVersionId: str = ...,
) -> CreateDeploymentResponseTypeDef:  # (2)
    ...
  1. See DeploymentTypeType
  2. See CreateDeploymentResponseTypeDef
Usage example with kwargs
kwargs: CreateDeploymentRequestRequestTypeDef = {  # (1)
    "DeploymentType": ...,
    "GroupId": ...,
}

parent.create_deployment(**kwargs)
  1. See CreateDeploymentRequestRequestTypeDef

create_device_definition

Creates a device definition.

Type annotations and code completion for boto3.client("greengrass").create_device_definition method. boto3 documentation

Method definition
def create_device_definition(
    self,
    *,
    AmznClientToken: str = ...,
    InitialVersion: DeviceDefinitionVersionTypeDef = ...,  # (1)
    Name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateDeviceDefinitionResponseTypeDef:  # (2)
    ...
  1. See DeviceDefinitionVersionTypeDef
  2. See CreateDeviceDefinitionResponseTypeDef
Usage example with kwargs
kwargs: CreateDeviceDefinitionRequestRequestTypeDef = {  # (1)
    "AmznClientToken": ...,
}

parent.create_device_definition(**kwargs)
  1. See CreateDeviceDefinitionRequestRequestTypeDef

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

Method definition
def create_device_definition_version(
    self,
    *,
    DeviceDefinitionId: str,
    AmznClientToken: str = ...,
    Devices: Sequence[DeviceTypeDef] = ...,  # (1)
) -> CreateDeviceDefinitionVersionResponseTypeDef:  # (2)
    ...
  1. See DeviceTypeDef
  2. See CreateDeviceDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateDeviceDefinitionVersionRequestRequestTypeDef = {  # (1)
    "DeviceDefinitionId": ...,
}

parent.create_device_definition_version(**kwargs)
  1. See CreateDeviceDefinitionVersionRequestRequestTypeDef

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

Method definition
def create_function_definition(
    self,
    *,
    AmznClientToken: str = ...,
    InitialVersion: FunctionDefinitionVersionTypeDef = ...,  # (1)
    Name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateFunctionDefinitionResponseTypeDef:  # (2)
    ...
  1. See FunctionDefinitionVersionTypeDef
  2. See CreateFunctionDefinitionResponseTypeDef
Usage example with kwargs
kwargs: CreateFunctionDefinitionRequestRequestTypeDef = {  # (1)
    "AmznClientToken": ...,
}

parent.create_function_definition(**kwargs)
  1. See CreateFunctionDefinitionRequestRequestTypeDef

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

Method definition
def create_function_definition_version(
    self,
    *,
    FunctionDefinitionId: str,
    AmznClientToken: str = ...,
    DefaultConfig: FunctionDefaultConfigTypeDef = ...,  # (1)
    Functions: Sequence[FunctionTypeDef] = ...,  # (2)
) -> CreateFunctionDefinitionVersionResponseTypeDef:  # (3)
    ...
  1. See FunctionDefaultConfigTypeDef
  2. See FunctionTypeDef
  3. See CreateFunctionDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateFunctionDefinitionVersionRequestRequestTypeDef = {  # (1)
    "FunctionDefinitionId": ...,
}

parent.create_function_definition_version(**kwargs)
  1. See CreateFunctionDefinitionVersionRequestRequestTypeDef

create_group

Creates a group.

Type annotations and code completion for boto3.client("greengrass").create_group method. boto3 documentation

Method definition
def create_group(
    self,
    *,
    Name: str,
    AmznClientToken: str = ...,
    InitialVersion: GroupVersionTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateGroupResponseTypeDef:  # (2)
    ...
  1. See GroupVersionTypeDef
  2. See CreateGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_group(**kwargs)
  1. See CreateGroupRequestRequestTypeDef

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

Method definition
def create_group_certificate_authority(
    self,
    *,
    GroupId: str,
    AmznClientToken: str = ...,
) -> CreateGroupCertificateAuthorityResponseTypeDef:  # (1)
    ...
  1. See CreateGroupCertificateAuthorityResponseTypeDef
Usage example with kwargs
kwargs: CreateGroupCertificateAuthorityRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.create_group_certificate_authority(**kwargs)
  1. See CreateGroupCertificateAuthorityRequestRequestTypeDef

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

Method definition
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)
    ...
  1. See CreateGroupVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateGroupVersionRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.create_group_version(**kwargs)
  1. See CreateGroupVersionRequestRequestTypeDef

create_logger_definition

Creates a logger definition.

Type annotations and code completion for boto3.client("greengrass").create_logger_definition method. boto3 documentation

Method definition
def create_logger_definition(
    self,
    *,
    AmznClientToken: str = ...,
    InitialVersion: LoggerDefinitionVersionTypeDef = ...,  # (1)
    Name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateLoggerDefinitionResponseTypeDef:  # (2)
    ...
  1. See LoggerDefinitionVersionTypeDef
  2. See CreateLoggerDefinitionResponseTypeDef
Usage example with kwargs
kwargs: CreateLoggerDefinitionRequestRequestTypeDef = {  # (1)
    "AmznClientToken": ...,
}

parent.create_logger_definition(**kwargs)
  1. See CreateLoggerDefinitionRequestRequestTypeDef

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

Method definition
def create_logger_definition_version(
    self,
    *,
    LoggerDefinitionId: str,
    AmznClientToken: str = ...,
    Loggers: Sequence[LoggerTypeDef] = ...,  # (1)
) -> CreateLoggerDefinitionVersionResponseTypeDef:  # (2)
    ...
  1. See LoggerTypeDef
  2. See CreateLoggerDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateLoggerDefinitionVersionRequestRequestTypeDef = {  # (1)
    "LoggerDefinitionId": ...,
}

parent.create_logger_definition_version(**kwargs)
  1. See CreateLoggerDefinitionVersionRequestRequestTypeDef

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

Method definition
def create_resource_definition(
    self,
    *,
    AmznClientToken: str = ...,
    InitialVersion: ResourceDefinitionVersionTypeDef = ...,  # (1)
    Name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateResourceDefinitionResponseTypeDef:  # (2)
    ...
  1. See ResourceDefinitionVersionTypeDef
  2. See CreateResourceDefinitionResponseTypeDef
Usage example with kwargs
kwargs: CreateResourceDefinitionRequestRequestTypeDef = {  # (1)
    "AmznClientToken": ...,
}

parent.create_resource_definition(**kwargs)
  1. See CreateResourceDefinitionRequestRequestTypeDef

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

Method definition
def create_resource_definition_version(
    self,
    *,
    ResourceDefinitionId: str,
    AmznClientToken: str = ...,
    Resources: Sequence[ResourceTypeDef] = ...,  # (1)
) -> CreateResourceDefinitionVersionResponseTypeDef:  # (2)
    ...
  1. See ResourceTypeDef
  2. See CreateResourceDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateResourceDefinitionVersionRequestRequestTypeDef = {  # (1)
    "ResourceDefinitionId": ...,
}

parent.create_resource_definition_version(**kwargs)
  1. See CreateResourceDefinitionVersionRequestRequestTypeDef

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

Method definition
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)
    ...
  1. See SoftwareToUpdateType
  2. See UpdateTargetsArchitectureType
  3. See UpdateTargetsOperatingSystemType
  4. See UpdateAgentLogLevelType
  5. See CreateSoftwareUpdateJobResponseTypeDef
Usage example with kwargs
kwargs: CreateSoftwareUpdateJobRequestRequestTypeDef = {  # (1)
    "S3UrlSignerRole": ...,
    "SoftwareToUpdate": ...,
    "UpdateTargets": ...,
    "UpdateTargetsArchitecture": ...,
    "UpdateTargetsOperatingSystem": ...,
}

parent.create_software_update_job(**kwargs)
  1. See CreateSoftwareUpdateJobRequestRequestTypeDef

create_subscription_definition

Creates a subscription definition.

Type annotations and code completion for boto3.client("greengrass").create_subscription_definition method. boto3 documentation

Method definition
def create_subscription_definition(
    self,
    *,
    AmznClientToken: str = ...,
    InitialVersion: SubscriptionDefinitionVersionTypeDef = ...,  # (1)
    Name: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateSubscriptionDefinitionResponseTypeDef:  # (2)
    ...
  1. See SubscriptionDefinitionVersionTypeDef
  2. See CreateSubscriptionDefinitionResponseTypeDef
Usage example with kwargs
kwargs: CreateSubscriptionDefinitionRequestRequestTypeDef = {  # (1)
    "AmznClientToken": ...,
}

parent.create_subscription_definition(**kwargs)
  1. See CreateSubscriptionDefinitionRequestRequestTypeDef

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

Method definition
def create_subscription_definition_version(
    self,
    *,
    SubscriptionDefinitionId: str,
    AmznClientToken: str = ...,
    Subscriptions: Sequence[SubscriptionTypeDef] = ...,  # (1)
) -> CreateSubscriptionDefinitionVersionResponseTypeDef:  # (2)
    ...
  1. See SubscriptionTypeDef
  2. See CreateSubscriptionDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateSubscriptionDefinitionVersionRequestRequestTypeDef = {  # (1)
    "SubscriptionDefinitionId": ...,
}

parent.create_subscription_definition_version(**kwargs)
  1. See CreateSubscriptionDefinitionVersionRequestRequestTypeDef

delete_connector_definition

Deletes a connector definition.

Type annotations and code completion for boto3.client("greengrass").delete_connector_definition method. boto3 documentation

Method definition
def delete_connector_definition(
    self,
    *,
    ConnectorDefinitionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteConnectorDefinitionRequestRequestTypeDef = {  # (1)
    "ConnectorDefinitionId": ...,
}

parent.delete_connector_definition(**kwargs)
  1. See DeleteConnectorDefinitionRequestRequestTypeDef

delete_core_definition

Deletes a core definition.

Type annotations and code completion for boto3.client("greengrass").delete_core_definition method. boto3 documentation

Method definition
def delete_core_definition(
    self,
    *,
    CoreDefinitionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteCoreDefinitionRequestRequestTypeDef = {  # (1)
    "CoreDefinitionId": ...,
}

parent.delete_core_definition(**kwargs)
  1. See DeleteCoreDefinitionRequestRequestTypeDef

delete_device_definition

Deletes a device definition.

Type annotations and code completion for boto3.client("greengrass").delete_device_definition method. boto3 documentation

Method definition
def delete_device_definition(
    self,
    *,
    DeviceDefinitionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDeviceDefinitionRequestRequestTypeDef = {  # (1)
    "DeviceDefinitionId": ...,
}

parent.delete_device_definition(**kwargs)
  1. See DeleteDeviceDefinitionRequestRequestTypeDef

delete_function_definition

Deletes a Lambda function definition.

Type annotations and code completion for boto3.client("greengrass").delete_function_definition method. boto3 documentation

Method definition
def delete_function_definition(
    self,
    *,
    FunctionDefinitionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteFunctionDefinitionRequestRequestTypeDef = {  # (1)
    "FunctionDefinitionId": ...,
}

parent.delete_function_definition(**kwargs)
  1. See DeleteFunctionDefinitionRequestRequestTypeDef

delete_group

Deletes a group.

Type annotations and code completion for boto3.client("greengrass").delete_group method. boto3 documentation

Method definition
def delete_group(
    self,
    *,
    GroupId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteGroupRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.delete_group(**kwargs)
  1. See DeleteGroupRequestRequestTypeDef

delete_logger_definition

Deletes a logger definition.

Type annotations and code completion for boto3.client("greengrass").delete_logger_definition method. boto3 documentation

Method definition
def delete_logger_definition(
    self,
    *,
    LoggerDefinitionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteLoggerDefinitionRequestRequestTypeDef = {  # (1)
    "LoggerDefinitionId": ...,
}

parent.delete_logger_definition(**kwargs)
  1. See DeleteLoggerDefinitionRequestRequestTypeDef

delete_resource_definition

Deletes a resource definition.

Type annotations and code completion for boto3.client("greengrass").delete_resource_definition method. boto3 documentation

Method definition
def delete_resource_definition(
    self,
    *,
    ResourceDefinitionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteResourceDefinitionRequestRequestTypeDef = {  # (1)
    "ResourceDefinitionId": ...,
}

parent.delete_resource_definition(**kwargs)
  1. See DeleteResourceDefinitionRequestRequestTypeDef

delete_subscription_definition

Deletes a subscription definition.

Type annotations and code completion for boto3.client("greengrass").delete_subscription_definition method. boto3 documentation

Method definition
def delete_subscription_definition(
    self,
    *,
    SubscriptionDefinitionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteSubscriptionDefinitionRequestRequestTypeDef = {  # (1)
    "SubscriptionDefinitionId": ...,
}

parent.delete_subscription_definition(**kwargs)
  1. See DeleteSubscriptionDefinitionRequestRequestTypeDef

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

Method definition
def disassociate_role_from_group(
    self,
    *,
    GroupId: str,
) -> DisassociateRoleFromGroupResponseTypeDef:  # (1)
    ...
  1. See DisassociateRoleFromGroupResponseTypeDef
Usage example with kwargs
kwargs: DisassociateRoleFromGroupRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.disassociate_role_from_group(**kwargs)
  1. See DisassociateRoleFromGroupRequestRequestTypeDef

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

Method definition
def disassociate_service_role_from_account(
    self,
) -> DisassociateServiceRoleFromAccountResponseTypeDef:  # (1)
    ...
  1. See DisassociateServiceRoleFromAccountResponseTypeDef

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

Method definition
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

Method definition
def get_associated_role(
    self,
    *,
    GroupId: str,
) -> GetAssociatedRoleResponseTypeDef:  # (1)
    ...
  1. See GetAssociatedRoleResponseTypeDef
Usage example with kwargs
kwargs: GetAssociatedRoleRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.get_associated_role(**kwargs)
  1. See GetAssociatedRoleRequestRequestTypeDef

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

Method definition
def get_bulk_deployment_status(
    self,
    *,
    BulkDeploymentId: str,
) -> GetBulkDeploymentStatusResponseTypeDef:  # (1)
    ...
  1. See GetBulkDeploymentStatusResponseTypeDef
Usage example with kwargs
kwargs: GetBulkDeploymentStatusRequestRequestTypeDef = {  # (1)
    "BulkDeploymentId": ...,
}

parent.get_bulk_deployment_status(**kwargs)
  1. See GetBulkDeploymentStatusRequestRequestTypeDef

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

Method definition
def get_connectivity_info(
    self,
    *,
    ThingName: str,
) -> GetConnectivityInfoResponseTypeDef:  # (1)
    ...
  1. See GetConnectivityInfoResponseTypeDef
Usage example with kwargs
kwargs: GetConnectivityInfoRequestRequestTypeDef = {  # (1)
    "ThingName": ...,
}

parent.get_connectivity_info(**kwargs)
  1. See GetConnectivityInfoRequestRequestTypeDef

get_connector_definition

Retrieves information about a connector definition.

Type annotations and code completion for boto3.client("greengrass").get_connector_definition method. boto3 documentation

Method definition
def get_connector_definition(
    self,
    *,
    ConnectorDefinitionId: str,
) -> GetConnectorDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetConnectorDefinitionResponseTypeDef
Usage example with kwargs
kwargs: GetConnectorDefinitionRequestRequestTypeDef = {  # (1)
    "ConnectorDefinitionId": ...,
}

parent.get_connector_definition(**kwargs)
  1. See GetConnectorDefinitionRequestRequestTypeDef

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

Method definition
def get_connector_definition_version(
    self,
    *,
    ConnectorDefinitionId: str,
    ConnectorDefinitionVersionId: str,
    NextToken: str = ...,
) -> GetConnectorDefinitionVersionResponseTypeDef:  # (1)
    ...
  1. See GetConnectorDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: GetConnectorDefinitionVersionRequestRequestTypeDef = {  # (1)
    "ConnectorDefinitionId": ...,
    "ConnectorDefinitionVersionId": ...,
}

parent.get_connector_definition_version(**kwargs)
  1. See GetConnectorDefinitionVersionRequestRequestTypeDef

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

Method definition
def get_core_definition(
    self,
    *,
    CoreDefinitionId: str,
) -> GetCoreDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetCoreDefinitionResponseTypeDef
Usage example with kwargs
kwargs: GetCoreDefinitionRequestRequestTypeDef = {  # (1)
    "CoreDefinitionId": ...,
}

parent.get_core_definition(**kwargs)
  1. See GetCoreDefinitionRequestRequestTypeDef

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

Method definition
def get_core_definition_version(
    self,
    *,
    CoreDefinitionId: str,
    CoreDefinitionVersionId: str,
) -> GetCoreDefinitionVersionResponseTypeDef:  # (1)
    ...
  1. See GetCoreDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: GetCoreDefinitionVersionRequestRequestTypeDef = {  # (1)
    "CoreDefinitionId": ...,
    "CoreDefinitionVersionId": ...,
}

parent.get_core_definition_version(**kwargs)
  1. See GetCoreDefinitionVersionRequestRequestTypeDef

get_deployment_status

Returns the status of a deployment.

Type annotations and code completion for boto3.client("greengrass").get_deployment_status method. boto3 documentation

Method definition
def get_deployment_status(
    self,
    *,
    DeploymentId: str,
    GroupId: str,
) -> GetDeploymentStatusResponseTypeDef:  # (1)
    ...
  1. See GetDeploymentStatusResponseTypeDef
Usage example with kwargs
kwargs: GetDeploymentStatusRequestRequestTypeDef = {  # (1)
    "DeploymentId": ...,
    "GroupId": ...,
}

parent.get_deployment_status(**kwargs)
  1. See GetDeploymentStatusRequestRequestTypeDef

get_device_definition

Retrieves information about a device definition.

Type annotations and code completion for boto3.client("greengrass").get_device_definition method. boto3 documentation

Method definition
def get_device_definition(
    self,
    *,
    DeviceDefinitionId: str,
) -> GetDeviceDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetDeviceDefinitionResponseTypeDef
Usage example with kwargs
kwargs: GetDeviceDefinitionRequestRequestTypeDef = {  # (1)
    "DeviceDefinitionId": ...,
}

parent.get_device_definition(**kwargs)
  1. See GetDeviceDefinitionRequestRequestTypeDef

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

Method definition
def get_device_definition_version(
    self,
    *,
    DeviceDefinitionId: str,
    DeviceDefinitionVersionId: str,
    NextToken: str = ...,
) -> GetDeviceDefinitionVersionResponseTypeDef:  # (1)
    ...
  1. See GetDeviceDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: GetDeviceDefinitionVersionRequestRequestTypeDef = {  # (1)
    "DeviceDefinitionId": ...,
    "DeviceDefinitionVersionId": ...,
}

parent.get_device_definition_version(**kwargs)
  1. See GetDeviceDefinitionVersionRequestRequestTypeDef

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

Method definition
def get_function_definition(
    self,
    *,
    FunctionDefinitionId: str,
) -> GetFunctionDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetFunctionDefinitionResponseTypeDef
Usage example with kwargs
kwargs: GetFunctionDefinitionRequestRequestTypeDef = {  # (1)
    "FunctionDefinitionId": ...,
}

parent.get_function_definition(**kwargs)
  1. See GetFunctionDefinitionRequestRequestTypeDef

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 and code completion for boto3.client("greengrass").get_function_definition_version method. boto3 documentation

Method definition
def get_function_definition_version(
    self,
    *,
    FunctionDefinitionId: str,
    FunctionDefinitionVersionId: str,
    NextToken: str = ...,
) -> GetFunctionDefinitionVersionResponseTypeDef:  # (1)
    ...
  1. See GetFunctionDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: GetFunctionDefinitionVersionRequestRequestTypeDef = {  # (1)
    "FunctionDefinitionId": ...,
    "FunctionDefinitionVersionId": ...,
}

parent.get_function_definition_version(**kwargs)
  1. See GetFunctionDefinitionVersionRequestRequestTypeDef

get_group

Retrieves information about a group.

Type annotations and code completion for boto3.client("greengrass").get_group method. boto3 documentation

Method definition
def get_group(
    self,
    *,
    GroupId: str,
) -> GetGroupResponseTypeDef:  # (1)
    ...
  1. See GetGroupResponseTypeDef
Usage example with kwargs
kwargs: GetGroupRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.get_group(**kwargs)
  1. See GetGroupRequestRequestTypeDef

get_group_certificate_authority

Retreives the CA associated with a group.

Type annotations and code completion for boto3.client("greengrass").get_group_certificate_authority method. boto3 documentation

Method definition
def get_group_certificate_authority(
    self,
    *,
    CertificateAuthorityId: str,
    GroupId: str,
) -> GetGroupCertificateAuthorityResponseTypeDef:  # (1)
    ...
  1. See GetGroupCertificateAuthorityResponseTypeDef
Usage example with kwargs
kwargs: GetGroupCertificateAuthorityRequestRequestTypeDef = {  # (1)
    "CertificateAuthorityId": ...,
    "GroupId": ...,
}

parent.get_group_certificate_authority(**kwargs)
  1. See GetGroupCertificateAuthorityRequestRequestTypeDef

get_group_certificate_configuration

Retrieves the current configuration for the CA used by the group.

Type annotations and code completion for boto3.client("greengrass").get_group_certificate_configuration method. boto3 documentation

Method definition
def get_group_certificate_configuration(
    self,
    *,
    GroupId: str,
) -> GetGroupCertificateConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetGroupCertificateConfigurationResponseTypeDef
Usage example with kwargs
kwargs: GetGroupCertificateConfigurationRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.get_group_certificate_configuration(**kwargs)
  1. See GetGroupCertificateConfigurationRequestRequestTypeDef

get_group_version

Retrieves information about a group version.

Type annotations and code completion for boto3.client("greengrass").get_group_version method. boto3 documentation

Method definition
def get_group_version(
    self,
    *,
    GroupId: str,
    GroupVersionId: str,
) -> GetGroupVersionResponseTypeDef:  # (1)
    ...
  1. See GetGroupVersionResponseTypeDef
Usage example with kwargs
kwargs: GetGroupVersionRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
    "GroupVersionId": ...,
}

parent.get_group_version(**kwargs)
  1. See GetGroupVersionRequestRequestTypeDef

get_logger_definition

Retrieves information about a logger definition.

Type annotations and code completion for boto3.client("greengrass").get_logger_definition method. boto3 documentation

Method definition
def get_logger_definition(
    self,
    *,
    LoggerDefinitionId: str,
) -> GetLoggerDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetLoggerDefinitionResponseTypeDef
Usage example with kwargs
kwargs: GetLoggerDefinitionRequestRequestTypeDef = {  # (1)
    "LoggerDefinitionId": ...,
}

parent.get_logger_definition(**kwargs)
  1. See GetLoggerDefinitionRequestRequestTypeDef

get_logger_definition_version

Retrieves information about a logger definition version.

Type annotations and code completion for boto3.client("greengrass").get_logger_definition_version method. boto3 documentation

Method definition
def get_logger_definition_version(
    self,
    *,
    LoggerDefinitionId: str,
    LoggerDefinitionVersionId: str,
    NextToken: str = ...,
) -> GetLoggerDefinitionVersionResponseTypeDef:  # (1)
    ...
  1. See GetLoggerDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: GetLoggerDefinitionVersionRequestRequestTypeDef = {  # (1)
    "LoggerDefinitionId": ...,
    "LoggerDefinitionVersionId": ...,
}

parent.get_logger_definition_version(**kwargs)
  1. See GetLoggerDefinitionVersionRequestRequestTypeDef

get_resource_definition

Retrieves information about a resource definition, including its creation time and latest version.

Type annotations and code completion for boto3.client("greengrass").get_resource_definition method. boto3 documentation

Method definition
def get_resource_definition(
    self,
    *,
    ResourceDefinitionId: str,
) -> GetResourceDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetResourceDefinitionResponseTypeDef
Usage example with kwargs
kwargs: GetResourceDefinitionRequestRequestTypeDef = {  # (1)
    "ResourceDefinitionId": ...,
}

parent.get_resource_definition(**kwargs)
  1. See GetResourceDefinitionRequestRequestTypeDef

get_resource_definition_version

Retrieves information about a resource definition version, including which resources are included in the version.

Type annotations and code completion for boto3.client("greengrass").get_resource_definition_version method. boto3 documentation

Method definition
def get_resource_definition_version(
    self,
    *,
    ResourceDefinitionId: str,
    ResourceDefinitionVersionId: str,
) -> GetResourceDefinitionVersionResponseTypeDef:  # (1)
    ...
  1. See GetResourceDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: GetResourceDefinitionVersionRequestRequestTypeDef = {  # (1)
    "ResourceDefinitionId": ...,
    "ResourceDefinitionVersionId": ...,
}

parent.get_resource_definition_version(**kwargs)
  1. See GetResourceDefinitionVersionRequestRequestTypeDef

get_service_role_for_account

Retrieves the service role that is attached to your account.

Type annotations and code completion for boto3.client("greengrass").get_service_role_for_account method. boto3 documentation

Method definition
def get_service_role_for_account(
    self,
) -> GetServiceRoleForAccountResponseTypeDef:  # (1)
    ...
  1. See GetServiceRoleForAccountResponseTypeDef

get_subscription_definition

Retrieves information about a subscription definition.

Type annotations and code completion for boto3.client("greengrass").get_subscription_definition method. boto3 documentation

Method definition
def get_subscription_definition(
    self,
    *,
    SubscriptionDefinitionId: str,
) -> GetSubscriptionDefinitionResponseTypeDef:  # (1)
    ...
  1. See GetSubscriptionDefinitionResponseTypeDef
Usage example with kwargs
kwargs: GetSubscriptionDefinitionRequestRequestTypeDef = {  # (1)
    "SubscriptionDefinitionId": ...,
}

parent.get_subscription_definition(**kwargs)
  1. See GetSubscriptionDefinitionRequestRequestTypeDef

get_subscription_definition_version

Retrieves information about a subscription definition version.

Type annotations and code completion for boto3.client("greengrass").get_subscription_definition_version method. boto3 documentation

Method definition
def get_subscription_definition_version(
    self,
    *,
    SubscriptionDefinitionId: str,
    SubscriptionDefinitionVersionId: str,
    NextToken: str = ...,
) -> GetSubscriptionDefinitionVersionResponseTypeDef:  # (1)
    ...
  1. See GetSubscriptionDefinitionVersionResponseTypeDef
Usage example with kwargs
kwargs: GetSubscriptionDefinitionVersionRequestRequestTypeDef = {  # (1)
    "SubscriptionDefinitionId": ...,
    "SubscriptionDefinitionVersionId": ...,
}

parent.get_subscription_definition_version(**kwargs)
  1. See GetSubscriptionDefinitionVersionRequestRequestTypeDef

get_thing_runtime_configuration

Get the runtime configuration of a thing.

Type annotations and code completion for boto3.client("greengrass").get_thing_runtime_configuration method. boto3 documentation

Method definition
def get_thing_runtime_configuration(
    self,
    *,
    ThingName: str,
) -> GetThingRuntimeConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetThingRuntimeConfigurationResponseTypeDef
Usage example with kwargs
kwargs: GetThingRuntimeConfigurationRequestRequestTypeDef = {  # (1)
    "ThingName": ...,
}

parent.get_thing_runtime_configuration(**kwargs)
  1. See GetThingRuntimeConfigurationRequestRequestTypeDef

list_bulk_deployment_detailed_reports

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

Type annotations and code completion for boto3.client("greengrass").list_bulk_deployment_detailed_reports method. boto3 documentation

Method definition
def list_bulk_deployment_detailed_reports(
    self,
    *,
    BulkDeploymentId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListBulkDeploymentDetailedReportsResponseTypeDef:  # (1)
    ...
  1. See ListBulkDeploymentDetailedReportsResponseTypeDef
Usage example with kwargs
kwargs: ListBulkDeploymentDetailedReportsRequestRequestTypeDef = {  # (1)
    "BulkDeploymentId": ...,
}

parent.list_bulk_deployment_detailed_reports(**kwargs)
  1. See ListBulkDeploymentDetailedReportsRequestRequestTypeDef

list_bulk_deployments

Returns a list of bulk deployments.

Type annotations and code completion for boto3.client("greengrass").list_bulk_deployments method. boto3 documentation

Method definition
def list_bulk_deployments(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListBulkDeploymentsResponseTypeDef:  # (1)
    ...
  1. See ListBulkDeploymentsResponseTypeDef
Usage example with kwargs
kwargs: ListBulkDeploymentsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_bulk_deployments(**kwargs)
  1. See ListBulkDeploymentsRequestRequestTypeDef

list_connector_definition_versions

Lists the versions of a connector definition, which are containers for connectors.

Type annotations and code completion for boto3.client("greengrass").list_connector_definition_versions method. boto3 documentation

Method definition
def list_connector_definition_versions(
    self,
    *,
    ConnectorDefinitionId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListConnectorDefinitionVersionsResponseTypeDef:  # (1)
    ...
  1. See ListConnectorDefinitionVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListConnectorDefinitionVersionsRequestRequestTypeDef = {  # (1)
    "ConnectorDefinitionId": ...,
}

parent.list_connector_definition_versions(**kwargs)
  1. See ListConnectorDefinitionVersionsRequestRequestTypeDef

list_connector_definitions

Retrieves a list of connector definitions.

Type annotations and code completion for boto3.client("greengrass").list_connector_definitions method. boto3 documentation

Method definition
def list_connector_definitions(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListConnectorDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListConnectorDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListConnectorDefinitionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_connector_definitions(**kwargs)
  1. See ListConnectorDefinitionsRequestRequestTypeDef

list_core_definition_versions

Lists the versions of a core definition.

Type annotations and code completion for boto3.client("greengrass").list_core_definition_versions method. boto3 documentation

Method definition
def list_core_definition_versions(
    self,
    *,
    CoreDefinitionId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListCoreDefinitionVersionsResponseTypeDef:  # (1)
    ...
  1. See ListCoreDefinitionVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListCoreDefinitionVersionsRequestRequestTypeDef = {  # (1)
    "CoreDefinitionId": ...,
}

parent.list_core_definition_versions(**kwargs)
  1. See ListCoreDefinitionVersionsRequestRequestTypeDef

list_core_definitions

Retrieves a list of core definitions.

Type annotations and code completion for boto3.client("greengrass").list_core_definitions method. boto3 documentation

Method definition
def list_core_definitions(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListCoreDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListCoreDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListCoreDefinitionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_core_definitions(**kwargs)
  1. See ListCoreDefinitionsRequestRequestTypeDef

list_deployments

Returns a history of deployments for the group.

Type annotations and code completion for boto3.client("greengrass").list_deployments method. boto3 documentation

Method definition
def list_deployments(
    self,
    *,
    GroupId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListDeploymentsResponseTypeDef:  # (1)
    ...
  1. See ListDeploymentsResponseTypeDef
Usage example with kwargs
kwargs: ListDeploymentsRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.list_deployments(**kwargs)
  1. See ListDeploymentsRequestRequestTypeDef

list_device_definition_versions

Lists the versions of a device definition.

Type annotations and code completion for boto3.client("greengrass").list_device_definition_versions method. boto3 documentation

Method definition
def list_device_definition_versions(
    self,
    *,
    DeviceDefinitionId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListDeviceDefinitionVersionsResponseTypeDef:  # (1)
    ...
  1. See ListDeviceDefinitionVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListDeviceDefinitionVersionsRequestRequestTypeDef = {  # (1)
    "DeviceDefinitionId": ...,
}

parent.list_device_definition_versions(**kwargs)
  1. See ListDeviceDefinitionVersionsRequestRequestTypeDef

list_device_definitions

Retrieves a list of device definitions.

Type annotations and code completion for boto3.client("greengrass").list_device_definitions method. boto3 documentation

Method definition
def list_device_definitions(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListDeviceDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListDeviceDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListDeviceDefinitionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_device_definitions(**kwargs)
  1. See ListDeviceDefinitionsRequestRequestTypeDef

list_function_definition_versions

Lists the versions of a Lambda function definition.

Type annotations and code completion for boto3.client("greengrass").list_function_definition_versions method. boto3 documentation

Method definition
def list_function_definition_versions(
    self,
    *,
    FunctionDefinitionId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListFunctionDefinitionVersionsResponseTypeDef:  # (1)
    ...
  1. See ListFunctionDefinitionVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListFunctionDefinitionVersionsRequestRequestTypeDef = {  # (1)
    "FunctionDefinitionId": ...,
}

parent.list_function_definition_versions(**kwargs)
  1. See ListFunctionDefinitionVersionsRequestRequestTypeDef

list_function_definitions

Retrieves a list of Lambda function definitions.

Type annotations and code completion for boto3.client("greengrass").list_function_definitions method. boto3 documentation

Method definition
def list_function_definitions(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListFunctionDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListFunctionDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListFunctionDefinitionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_function_definitions(**kwargs)
  1. See ListFunctionDefinitionsRequestRequestTypeDef

list_group_certificate_authorities

Retrieves the current CAs for a group.

Type annotations and code completion for boto3.client("greengrass").list_group_certificate_authorities method. boto3 documentation

Method definition
def list_group_certificate_authorities(
    self,
    *,
    GroupId: str,
) -> ListGroupCertificateAuthoritiesResponseTypeDef:  # (1)
    ...
  1. See ListGroupCertificateAuthoritiesResponseTypeDef
Usage example with kwargs
kwargs: ListGroupCertificateAuthoritiesRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.list_group_certificate_authorities(**kwargs)
  1. See ListGroupCertificateAuthoritiesRequestRequestTypeDef

list_group_versions

Lists the versions of a group.

Type annotations and code completion for boto3.client("greengrass").list_group_versions method. boto3 documentation

Method definition
def list_group_versions(
    self,
    *,
    GroupId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListGroupVersionsResponseTypeDef:  # (1)
    ...
  1. See ListGroupVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListGroupVersionsRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.list_group_versions(**kwargs)
  1. See ListGroupVersionsRequestRequestTypeDef

list_groups

Retrieves a list of groups.

Type annotations and code completion for boto3.client("greengrass").list_groups method. boto3 documentation

Method definition
def list_groups(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListGroupsResponseTypeDef:  # (1)
    ...
  1. See ListGroupsResponseTypeDef
Usage example with kwargs
kwargs: ListGroupsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_groups(**kwargs)
  1. See ListGroupsRequestRequestTypeDef

list_logger_definition_versions

Lists the versions of a logger definition.

Type annotations and code completion for boto3.client("greengrass").list_logger_definition_versions method. boto3 documentation

Method definition
def list_logger_definition_versions(
    self,
    *,
    LoggerDefinitionId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListLoggerDefinitionVersionsResponseTypeDef:  # (1)
    ...
  1. See ListLoggerDefinitionVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListLoggerDefinitionVersionsRequestRequestTypeDef = {  # (1)
    "LoggerDefinitionId": ...,
}

parent.list_logger_definition_versions(**kwargs)
  1. See ListLoggerDefinitionVersionsRequestRequestTypeDef

list_logger_definitions

Retrieves a list of logger definitions.

Type annotations and code completion for boto3.client("greengrass").list_logger_definitions method. boto3 documentation

Method definition
def list_logger_definitions(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListLoggerDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListLoggerDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListLoggerDefinitionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_logger_definitions(**kwargs)
  1. See ListLoggerDefinitionsRequestRequestTypeDef

list_resource_definition_versions

Lists the versions of a resource definition.

Type annotations and code completion for boto3.client("greengrass").list_resource_definition_versions method. boto3 documentation

Method definition
def list_resource_definition_versions(
    self,
    *,
    ResourceDefinitionId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListResourceDefinitionVersionsResponseTypeDef:  # (1)
    ...
  1. See ListResourceDefinitionVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListResourceDefinitionVersionsRequestRequestTypeDef = {  # (1)
    "ResourceDefinitionId": ...,
}

parent.list_resource_definition_versions(**kwargs)
  1. See ListResourceDefinitionVersionsRequestRequestTypeDef

list_resource_definitions

Retrieves a list of resource definitions.

Type annotations and code completion for boto3.client("greengrass").list_resource_definitions method. boto3 documentation

Method definition
def list_resource_definitions(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListResourceDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListResourceDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListResourceDefinitionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_resource_definitions(**kwargs)
  1. See ListResourceDefinitionsRequestRequestTypeDef

list_subscription_definition_versions

Lists the versions of a subscription definition.

Type annotations and code completion for boto3.client("greengrass").list_subscription_definition_versions method. boto3 documentation

Method definition
def list_subscription_definition_versions(
    self,
    *,
    SubscriptionDefinitionId: str,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListSubscriptionDefinitionVersionsResponseTypeDef:  # (1)
    ...
  1. See ListSubscriptionDefinitionVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListSubscriptionDefinitionVersionsRequestRequestTypeDef = {  # (1)
    "SubscriptionDefinitionId": ...,
}

parent.list_subscription_definition_versions(**kwargs)
  1. See ListSubscriptionDefinitionVersionsRequestRequestTypeDef

list_subscription_definitions

Retrieves a list of subscription definitions.

Type annotations and code completion for boto3.client("greengrass").list_subscription_definitions method. boto3 documentation

Method definition
def list_subscription_definitions(
    self,
    *,
    MaxResults: str = ...,
    NextToken: str = ...,
) -> ListSubscriptionDefinitionsResponseTypeDef:  # (1)
    ...
  1. See ListSubscriptionDefinitionsResponseTypeDef
Usage example with kwargs
kwargs: ListSubscriptionDefinitionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_subscription_definitions(**kwargs)
  1. See ListSubscriptionDefinitionsRequestRequestTypeDef

list_tags_for_resource

Retrieves a list of resource tags for a resource arn.

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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

reset_deployments

Resets a group's deployments.

Type annotations and code completion for boto3.client("greengrass").reset_deployments method. boto3 documentation

Method definition
def reset_deployments(
    self,
    *,
    GroupId: str,
    AmznClientToken: str = ...,
    Force: bool = ...,
) -> ResetDeploymentsResponseTypeDef:  # (1)
    ...
  1. See ResetDeploymentsResponseTypeDef
Usage example with kwargs
kwargs: ResetDeploymentsRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.reset_deployments(**kwargs)
  1. See ResetDeploymentsRequestRequestTypeDef

start_bulk_deployment

Deploys multiple groups in one operation.

Type annotations and code completion for boto3.client("greengrass").start_bulk_deployment method. boto3 documentation

Method definition
def start_bulk_deployment(
    self,
    *,
    ExecutionRoleArn: str,
    InputFileUri: str,
    AmznClientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> StartBulkDeploymentResponseTypeDef:  # (1)
    ...
  1. See StartBulkDeploymentResponseTypeDef
Usage example with kwargs
kwargs: StartBulkDeploymentRequestRequestTypeDef = {  # (1)
    "ExecutionRoleArn": ...,
    "InputFileUri": ...,
}

parent.start_bulk_deployment(**kwargs)
  1. See StartBulkDeploymentRequestRequestTypeDef

stop_bulk_deployment

Stops the execution of a bulk deployment.

Type annotations and code completion for boto3.client("greengrass").stop_bulk_deployment method. boto3 documentation

Method definition
def stop_bulk_deployment(
    self,
    *,
    BulkDeploymentId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: StopBulkDeploymentRequestRequestTypeDef = {  # (1)
    "BulkDeploymentId": ...,
}

parent.stop_bulk_deployment(**kwargs)
  1. See StopBulkDeploymentRequestRequestTypeDef

tag_resource

Adds tags to a Greengrass resource.

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

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Remove resource tags from a Greengrass Resource.

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

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_connectivity_info

Updates the connectivity information for the core.

Type annotations and code completion for boto3.client("greengrass").update_connectivity_info method. boto3 documentation

Method definition
def update_connectivity_info(
    self,
    *,
    ThingName: str,
    ConnectivityInfo: Sequence[ConnectivityInfoTypeDef] = ...,  # (1)
) -> UpdateConnectivityInfoResponseTypeDef:  # (2)
    ...
  1. See ConnectivityInfoTypeDef
  2. See UpdateConnectivityInfoResponseTypeDef
Usage example with kwargs
kwargs: UpdateConnectivityInfoRequestRequestTypeDef = {  # (1)
    "ThingName": ...,
}

parent.update_connectivity_info(**kwargs)
  1. See UpdateConnectivityInfoRequestRequestTypeDef

update_connector_definition

Updates a connector definition.

Type annotations and code completion for boto3.client("greengrass").update_connector_definition method. boto3 documentation

Method definition
def update_connector_definition(
    self,
    *,
    ConnectorDefinitionId: str,
    Name: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateConnectorDefinitionRequestRequestTypeDef = {  # (1)
    "ConnectorDefinitionId": ...,
}

parent.update_connector_definition(**kwargs)
  1. See UpdateConnectorDefinitionRequestRequestTypeDef

update_core_definition

Updates a core definition.

Type annotations and code completion for boto3.client("greengrass").update_core_definition method. boto3 documentation

Method definition
def update_core_definition(
    self,
    *,
    CoreDefinitionId: str,
    Name: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateCoreDefinitionRequestRequestTypeDef = {  # (1)
    "CoreDefinitionId": ...,
}

parent.update_core_definition(**kwargs)
  1. See UpdateCoreDefinitionRequestRequestTypeDef

update_device_definition

Updates a device definition.

Type annotations and code completion for boto3.client("greengrass").update_device_definition method. boto3 documentation

Method definition
def update_device_definition(
    self,
    *,
    DeviceDefinitionId: str,
    Name: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateDeviceDefinitionRequestRequestTypeDef = {  # (1)
    "DeviceDefinitionId": ...,
}

parent.update_device_definition(**kwargs)
  1. See UpdateDeviceDefinitionRequestRequestTypeDef

update_function_definition

Updates a Lambda function definition.

Type annotations and code completion for boto3.client("greengrass").update_function_definition method. boto3 documentation

Method definition
def update_function_definition(
    self,
    *,
    FunctionDefinitionId: str,
    Name: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateFunctionDefinitionRequestRequestTypeDef = {  # (1)
    "FunctionDefinitionId": ...,
}

parent.update_function_definition(**kwargs)
  1. See UpdateFunctionDefinitionRequestRequestTypeDef

update_group

Updates a group.

Type annotations and code completion for boto3.client("greengrass").update_group method. boto3 documentation

Method definition
def update_group(
    self,
    *,
    GroupId: str,
    Name: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateGroupRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.update_group(**kwargs)
  1. See UpdateGroupRequestRequestTypeDef

update_group_certificate_configuration

Updates the Certificate expiry time for a group.

Type annotations and code completion for boto3.client("greengrass").update_group_certificate_configuration method. boto3 documentation

Method definition
def update_group_certificate_configuration(
    self,
    *,
    GroupId: str,
    CertificateExpiryInMilliseconds: str = ...,
) -> UpdateGroupCertificateConfigurationResponseTypeDef:  # (1)
    ...
  1. See UpdateGroupCertificateConfigurationResponseTypeDef
Usage example with kwargs
kwargs: UpdateGroupCertificateConfigurationRequestRequestTypeDef = {  # (1)
    "GroupId": ...,
}

parent.update_group_certificate_configuration(**kwargs)
  1. See UpdateGroupCertificateConfigurationRequestRequestTypeDef

update_logger_definition

Updates a logger definition.

Type annotations and code completion for boto3.client("greengrass").update_logger_definition method. boto3 documentation

Method definition
def update_logger_definition(
    self,
    *,
    LoggerDefinitionId: str,
    Name: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateLoggerDefinitionRequestRequestTypeDef = {  # (1)
    "LoggerDefinitionId": ...,
}

parent.update_logger_definition(**kwargs)
  1. See UpdateLoggerDefinitionRequestRequestTypeDef

update_resource_definition

Updates a resource definition.

Type annotations and code completion for boto3.client("greengrass").update_resource_definition method. boto3 documentation

Method definition
def update_resource_definition(
    self,
    *,
    ResourceDefinitionId: str,
    Name: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateResourceDefinitionRequestRequestTypeDef = {  # (1)
    "ResourceDefinitionId": ...,
}

parent.update_resource_definition(**kwargs)
  1. See UpdateResourceDefinitionRequestRequestTypeDef

update_subscription_definition

Updates a subscription definition.

Type annotations and code completion for boto3.client("greengrass").update_subscription_definition method. boto3 documentation

Method definition
def update_subscription_definition(
    self,
    *,
    SubscriptionDefinitionId: str,
    Name: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateSubscriptionDefinitionRequestRequestTypeDef = {  # (1)
    "SubscriptionDefinitionId": ...,
}

parent.update_subscription_definition(**kwargs)
  1. See UpdateSubscriptionDefinitionRequestRequestTypeDef

update_thing_runtime_configuration

Updates the runtime configuration of a thing.

Type annotations and code completion for boto3.client("greengrass").update_thing_runtime_configuration method. boto3 documentation

Method definition
def update_thing_runtime_configuration(
    self,
    *,
    ThingName: str,
    TelemetryConfiguration: TelemetryConfigurationUpdateTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See TelemetryConfigurationUpdateTypeDef
Usage example with kwargs
kwargs: UpdateThingRuntimeConfigurationRequestRequestTypeDef = {  # (1)
    "ThingName": ...,
}

parent.update_thing_runtime_configuration(**kwargs)
  1. See UpdateThingRuntimeConfigurationRequestRequestTypeDef

get_paginator

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