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

# GreengrassClient 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.

# Exceptions.exceptions usage example

client = boto3.client("greengrass")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerErrorException,
) as e:
    print(e)
# Exceptions.exceptions 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

# associate_role_to_group method definition

def associate_role_to_group(
    self,
    *,
    GroupId: str,
    RoleArn: str,
) -> AssociateRoleToGroupResponseTypeDef:  # (1)
    ...
  1. See AssociateRoleToGroupResponseTypeDef
# associate_role_to_group method usage example with argument unpacking

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

# associate_service_role_to_account method definition

def associate_service_role_to_account(
    self,
    *,
    RoleArn: str,
) -> AssociateServiceRoleToAccountResponseTypeDef:  # (1)
    ...
  1. See AssociateServiceRoleToAccountResponseTypeDef
# associate_service_role_to_account method usage example with argument unpacking

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

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

# close 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

# create_connector_definition 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
# create_connector_definition method usage example with argument unpacking

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

# create_connector_definition_version method definition

def create_connector_definition_version(
    self,
    *,
    ConnectorDefinitionId: str,
    AmznClientToken: str = ...,
    Connectors: Sequence[ConnectorTypeDef] = ...,  # (1)
) -> CreateConnectorDefinitionVersionResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeDef
  2. See CreateConnectorDefinitionVersionResponseTypeDef
# create_connector_definition_version method usage example with argument unpacking

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

# create_core_definition 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
# create_core_definition method usage example with argument unpacking

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

# create_core_definition_version method definition

def create_core_definition_version(
    self,
    *,
    CoreDefinitionId: str,
    AmznClientToken: str = ...,
    Cores: Sequence[CoreTypeDef] = ...,  # (1)
) -> CreateCoreDefinitionVersionResponseTypeDef:  # (2)
    ...
  1. See CoreTypeDef
  2. See CreateCoreDefinitionVersionResponseTypeDef
# create_core_definition_version method usage example with argument unpacking

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

# create_deployment 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
# create_deployment method usage example with argument unpacking

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.