Struct aws_sdk_greengrass::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Greengrass
Client for invoking operations on AWS Greengrass. Each operation on AWS Greengrass is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_greengrass::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_greengrass::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AssociateRoleToGroup
operation has
a Client::associate_role_to_group
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_role_to_group()
.group_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn associate_role_to_group(&self) -> AssociateRoleToGroupFluentBuilder
pub fn associate_role_to_group(&self) -> AssociateRoleToGroupFluentBuilder
Constructs a fluent builder for the AssociateRoleToGroup
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: true
The ARN of the role you wish to associate with this group. The existence of the role is not validated.
- On success, responds with
AssociateRoleToGroupOutput
with field(s):associated_at(Option<String>)
: The time, in milliseconds since the epoch, when the role ARN was associated with the group.
- On failure, responds with
SdkError<AssociateRoleToGroupError>
source§impl Client
impl Client
sourcepub fn associate_service_role_to_account(
&self,
) -> AssociateServiceRoleToAccountFluentBuilder
pub fn associate_service_role_to_account( &self, ) -> AssociateServiceRoleToAccountFluentBuilder
Constructs a fluent builder for the AssociateServiceRoleToAccount
operation.
- The fluent builder is configurable:
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: true
The ARN of the service role you wish to associate with your account.
- On success, responds with
AssociateServiceRoleToAccountOutput
with field(s):associated_at(Option<String>)
: The time when the service role was associated with the account.
- On failure, responds with
SdkError<AssociateServiceRoleToAccountError>
source§impl Client
impl Client
sourcepub fn create_connector_definition(
&self,
) -> CreateConnectorDefinitionFluentBuilder
pub fn create_connector_definition( &self, ) -> CreateConnectorDefinitionFluentBuilder
Constructs a fluent builder for the CreateConnectorDefinition
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.initial_version(ConnectorDefinitionVersion)
/set_initial_version(Option<ConnectorDefinitionVersion>)
:
required: false
Information about the initial version of the connector definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the connector definition.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Tag(s) to add to the new resource.
- On success, responds with
CreateConnectorDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.
- On failure, responds with
SdkError<CreateConnectorDefinitionError>
source§impl Client
impl Client
sourcepub fn create_connector_definition_version(
&self,
) -> CreateConnectorDefinitionVersionFluentBuilder
pub fn create_connector_definition_version( &self, ) -> CreateConnectorDefinitionVersionFluentBuilder
Constructs a fluent builder for the CreateConnectorDefinitionVersion
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.connector_definition_id(impl Into<String>)
/set_connector_definition_id(Option<String>)
:
required: true
The ID of the connector definition.connectors(Connector)
/set_connectors(Option<Vec::<Connector>>)
:
required: false
A list of references to connectors in this version, with their corresponding configuration settings.
- On success, responds with
CreateConnectorDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the version was created.id(Option<String>)
: The ID of the parent definition that the version is associated with.version(Option<String>)
: The ID of the version.
- On failure, responds with
SdkError<CreateConnectorDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn create_core_definition(&self) -> CreateCoreDefinitionFluentBuilder
pub fn create_core_definition(&self) -> CreateCoreDefinitionFluentBuilder
Constructs a fluent builder for the CreateCoreDefinition
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.initial_version(CoreDefinitionVersion)
/set_initial_version(Option<CoreDefinitionVersion>)
:
required: false
Information about the initial version of the core definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the core definition.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Tag(s) to add to the new resource.
- On success, responds with
CreateCoreDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.
- On failure, responds with
SdkError<CreateCoreDefinitionError>
source§impl Client
impl Client
sourcepub fn create_core_definition_version(
&self,
) -> CreateCoreDefinitionVersionFluentBuilder
pub fn create_core_definition_version( &self, ) -> CreateCoreDefinitionVersionFluentBuilder
Constructs a fluent builder for the CreateCoreDefinitionVersion
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.core_definition_id(impl Into<String>)
/set_core_definition_id(Option<String>)
:
required: true
The ID of the core definition.cores(Core)
/set_cores(Option<Vec::<Core>>)
:
required: false
A list of cores in the core definition version.
- On success, responds with
CreateCoreDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the version was created.id(Option<String>)
: The ID of the parent definition that the version is associated with.version(Option<String>)
: The ID of the version.
- On failure, responds with
SdkError<CreateCoreDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
pub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
Constructs a fluent builder for the CreateDeployment
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: false
The ID of the deployment if you wish to redeploy a previous deployment.deployment_type(DeploymentType)
/set_deployment_type(Option<DeploymentType>)
:
required: true
The type of deployment. When used for ’‘CreateDeployment’’, only ’‘NewDeployment’’ and ’‘Redeployment’’ are valid.group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.group_version_id(impl Into<String>)
/set_group_version_id(Option<String>)
:
required: false
The ID of the group version to be deployed.
- On success, responds with
CreateDeploymentOutput
with field(s):deployment_arn(Option<String>)
: The ARN of the deployment.deployment_id(Option<String>)
: The ID of the deployment.
- On failure, responds with
SdkError<CreateDeploymentError>
source§impl Client
impl Client
sourcepub fn create_device_definition(&self) -> CreateDeviceDefinitionFluentBuilder
pub fn create_device_definition(&self) -> CreateDeviceDefinitionFluentBuilder
Constructs a fluent builder for the CreateDeviceDefinition
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.initial_version(DeviceDefinitionVersion)
/set_initial_version(Option<DeviceDefinitionVersion>)
:
required: false
Information about the initial version of the device definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the device definition.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Tag(s) to add to the new resource.
- On success, responds with
CreateDeviceDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.
- On failure, responds with
SdkError<CreateDeviceDefinitionError>
source§impl Client
impl Client
sourcepub fn create_device_definition_version(
&self,
) -> CreateDeviceDefinitionVersionFluentBuilder
pub fn create_device_definition_version( &self, ) -> CreateDeviceDefinitionVersionFluentBuilder
Constructs a fluent builder for the CreateDeviceDefinitionVersion
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.device_definition_id(impl Into<String>)
/set_device_definition_id(Option<String>)
:
required: true
The ID of the device definition.devices(Device)
/set_devices(Option<Vec::<Device>>)
:
required: false
A list of devices in the definition version.
- On success, responds with
CreateDeviceDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the version was created.id(Option<String>)
: The ID of the parent definition that the version is associated with.version(Option<String>)
: The ID of the version.
- On failure, responds with
SdkError<CreateDeviceDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn create_function_definition(
&self,
) -> CreateFunctionDefinitionFluentBuilder
pub fn create_function_definition( &self, ) -> CreateFunctionDefinitionFluentBuilder
Constructs a fluent builder for the CreateFunctionDefinition
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.initial_version(FunctionDefinitionVersion)
/set_initial_version(Option<FunctionDefinitionVersion>)
:
required: false
Information about the initial version of the function definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the function definition.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Tag(s) to add to the new resource.
- On success, responds with
CreateFunctionDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.
- On failure, responds with
SdkError<CreateFunctionDefinitionError>
source§impl Client
impl Client
sourcepub fn create_function_definition_version(
&self,
) -> CreateFunctionDefinitionVersionFluentBuilder
pub fn create_function_definition_version( &self, ) -> CreateFunctionDefinitionVersionFluentBuilder
Constructs a fluent builder for the CreateFunctionDefinitionVersion
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.default_config(FunctionDefaultConfig)
/set_default_config(Option<FunctionDefaultConfig>)
:
required: false
The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.function_definition_id(impl Into<String>)
/set_function_definition_id(Option<String>)
:
required: true
The ID of the Lambda function definition.functions(Function)
/set_functions(Option<Vec::<Function>>)
:
required: false
A list of Lambda functions in this function definition version.
- On success, responds with
CreateFunctionDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the version was created.id(Option<String>)
: The ID of the parent definition that the version is associated with.version(Option<String>)
: The ID of the version.
- On failure, responds with
SdkError<CreateFunctionDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn create_group(&self) -> CreateGroupFluentBuilder
pub fn create_group(&self) -> CreateGroupFluentBuilder
Constructs a fluent builder for the CreateGroup
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.initial_version(GroupVersion)
/set_initial_version(Option<GroupVersion>)
:
required: false
Information about the initial version of the group.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the group.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Tag(s) to add to the new resource.
- On success, responds with
CreateGroupOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.
- On failure, responds with
SdkError<CreateGroupError>
source§impl Client
impl Client
Constructs a fluent builder for the CreateGroupCertificateAuthority
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
CreateGroupCertificateAuthorityOutput
with field(s):group_certificate_authority_arn(Option<String>)
: The ARN of the group certificate authority.
- On failure, responds with
SdkError<CreateGroupCertificateAuthorityError>
source§impl Client
impl Client
sourcepub fn create_group_version(&self) -> CreateGroupVersionFluentBuilder
pub fn create_group_version(&self) -> CreateGroupVersionFluentBuilder
Constructs a fluent builder for the CreateGroupVersion
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.connector_definition_version_arn(impl Into<String>)
/set_connector_definition_version_arn(Option<String>)
:
required: false
The ARN of the connector definition version for this group.core_definition_version_arn(impl Into<String>)
/set_core_definition_version_arn(Option<String>)
:
required: false
The ARN of the core definition version for this group.device_definition_version_arn(impl Into<String>)
/set_device_definition_version_arn(Option<String>)
:
required: false
The ARN of the device definition version for this group.function_definition_version_arn(impl Into<String>)
/set_function_definition_version_arn(Option<String>)
:
required: false
The ARN of the function definition version for this group.group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.logger_definition_version_arn(impl Into<String>)
/set_logger_definition_version_arn(Option<String>)
:
required: false
The ARN of the logger definition version for this group.resource_definition_version_arn(impl Into<String>)
/set_resource_definition_version_arn(Option<String>)
:
required: false
The ARN of the resource definition version for this group.subscription_definition_version_arn(impl Into<String>)
/set_subscription_definition_version_arn(Option<String>)
:
required: false
The ARN of the subscription definition version for this group.
- On success, responds with
CreateGroupVersionOutput
with field(s):arn(Option<String>)
: The ARN of the version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the version was created.id(Option<String>)
: The ID of the parent definition that the version is associated with.version(Option<String>)
: The ID of the version.
- On failure, responds with
SdkError<CreateGroupVersionError>
source§impl Client
impl Client
sourcepub fn create_logger_definition(&self) -> CreateLoggerDefinitionFluentBuilder
pub fn create_logger_definition(&self) -> CreateLoggerDefinitionFluentBuilder
Constructs a fluent builder for the CreateLoggerDefinition
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.initial_version(LoggerDefinitionVersion)
/set_initial_version(Option<LoggerDefinitionVersion>)
:
required: false
Information about the initial version of the logger definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the logger definition.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Tag(s) to add to the new resource.
- On success, responds with
CreateLoggerDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.
- On failure, responds with
SdkError<CreateLoggerDefinitionError>
source§impl Client
impl Client
sourcepub fn create_logger_definition_version(
&self,
) -> CreateLoggerDefinitionVersionFluentBuilder
pub fn create_logger_definition_version( &self, ) -> CreateLoggerDefinitionVersionFluentBuilder
Constructs a fluent builder for the CreateLoggerDefinitionVersion
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.logger_definition_id(impl Into<String>)
/set_logger_definition_id(Option<String>)
:
required: true
The ID of the logger definition.loggers(Logger)
/set_loggers(Option<Vec::<Logger>>)
:
required: false
A list of loggers.
- On success, responds with
CreateLoggerDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the version was created.id(Option<String>)
: The ID of the parent definition that the version is associated with.version(Option<String>)
: The ID of the version.
- On failure, responds with
SdkError<CreateLoggerDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn create_resource_definition(
&self,
) -> CreateResourceDefinitionFluentBuilder
pub fn create_resource_definition( &self, ) -> CreateResourceDefinitionFluentBuilder
Constructs a fluent builder for the CreateResourceDefinition
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.initial_version(ResourceDefinitionVersion)
/set_initial_version(Option<ResourceDefinitionVersion>)
:
required: false
Information about the initial version of the resource definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the resource definition.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Tag(s) to add to the new resource.
- On success, responds with
CreateResourceDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.
- On failure, responds with
SdkError<CreateResourceDefinitionError>
source§impl Client
impl Client
sourcepub fn create_resource_definition_version(
&self,
) -> CreateResourceDefinitionVersionFluentBuilder
pub fn create_resource_definition_version( &self, ) -> CreateResourceDefinitionVersionFluentBuilder
Constructs a fluent builder for the CreateResourceDefinitionVersion
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.resource_definition_id(impl Into<String>)
/set_resource_definition_id(Option<String>)
:
required: true
The ID of the resource definition.resources(Resource)
/set_resources(Option<Vec::<Resource>>)
:
required: false
A list of resources.
- On success, responds with
CreateResourceDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the version was created.id(Option<String>)
: The ID of the parent definition that the version is associated with.version(Option<String>)
: The ID of the version.
- On failure, responds with
SdkError<CreateResourceDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn create_software_update_job(&self) -> CreateSoftwareUpdateJobFluentBuilder
pub fn create_software_update_job(&self) -> CreateSoftwareUpdateJobFluentBuilder
Constructs a fluent builder for the CreateSoftwareUpdateJob
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.s3_url_signer_role(impl Into<String>)
/set_s3_url_signer_role(Option<String>)
:
required: true
The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.software_to_update(SoftwareToUpdate)
/set_software_to_update(Option<SoftwareToUpdate>)
:
required: true
The piece of software on the Greengrass core that will be updated.update_agent_log_level(UpdateAgentLogLevel)
/set_update_agent_log_level(Option<UpdateAgentLogLevel>)
:
required: false
The minimum level of log statements that should be logged by the OTA Agent during an update.update_targets(impl Into<String>)
/set_update_targets(Option<Vec::<String>>)
:
required: true
The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.update_targets_architecture(UpdateTargetsArchitecture)
/set_update_targets_architecture(Option<UpdateTargetsArchitecture>)
:
required: true
The architecture of the cores which are the targets of an update.update_targets_operating_system(UpdateTargetsOperatingSystem)
/set_update_targets_operating_system(Option<UpdateTargetsOperatingSystem>)
:
required: true
The operating system of the cores which are the targets of an update.
- On success, responds with
CreateSoftwareUpdateJobOutput
with field(s):iot_job_arn(Option<String>)
: The IoT Job ARN corresponding to this update.iot_job_id(Option<String>)
: The IoT Job Id corresponding to this update.platform_software_version(Option<String>)
: The software version installed on the device or devices after the update.
- On failure, responds with
SdkError<CreateSoftwareUpdateJobError>
source§impl Client
impl Client
sourcepub fn create_subscription_definition(
&self,
) -> CreateSubscriptionDefinitionFluentBuilder
pub fn create_subscription_definition( &self, ) -> CreateSubscriptionDefinitionFluentBuilder
Constructs a fluent builder for the CreateSubscriptionDefinition
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.initial_version(SubscriptionDefinitionVersion)
/set_initial_version(Option<SubscriptionDefinitionVersion>)
:
required: false
Information about the initial version of the subscription definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the subscription definition.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Tag(s) to add to the new resource.
- On success, responds with
CreateSubscriptionDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.
- On failure, responds with
SdkError<CreateSubscriptionDefinitionError>
source§impl Client
impl Client
sourcepub fn create_subscription_definition_version(
&self,
) -> CreateSubscriptionDefinitionVersionFluentBuilder
pub fn create_subscription_definition_version( &self, ) -> CreateSubscriptionDefinitionVersionFluentBuilder
Constructs a fluent builder for the CreateSubscriptionDefinitionVersion
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.subscription_definition_id(impl Into<String>)
/set_subscription_definition_id(Option<String>)
:
required: true
The ID of the subscription definition.subscriptions(Subscription)
/set_subscriptions(Option<Vec::<Subscription>>)
:
required: false
A list of subscriptions.
- On success, responds with
CreateSubscriptionDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the version was created.id(Option<String>)
: The ID of the parent definition that the version is associated with.version(Option<String>)
: The ID of the version.
- On failure, responds with
SdkError<CreateSubscriptionDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn delete_connector_definition(
&self,
) -> DeleteConnectorDefinitionFluentBuilder
pub fn delete_connector_definition( &self, ) -> DeleteConnectorDefinitionFluentBuilder
Constructs a fluent builder for the DeleteConnectorDefinition
operation.
- The fluent builder is configurable:
connector_definition_id(impl Into<String>)
/set_connector_definition_id(Option<String>)
:
required: true
The ID of the connector definition.
- On success, responds with
DeleteConnectorDefinitionOutput
- On failure, responds with
SdkError<DeleteConnectorDefinitionError>
source§impl Client
impl Client
sourcepub fn delete_core_definition(&self) -> DeleteCoreDefinitionFluentBuilder
pub fn delete_core_definition(&self) -> DeleteCoreDefinitionFluentBuilder
Constructs a fluent builder for the DeleteCoreDefinition
operation.
- The fluent builder is configurable:
core_definition_id(impl Into<String>)
/set_core_definition_id(Option<String>)
:
required: true
The ID of the core definition.
- On success, responds with
DeleteCoreDefinitionOutput
- On failure, responds with
SdkError<DeleteCoreDefinitionError>
source§impl Client
impl Client
sourcepub fn delete_device_definition(&self) -> DeleteDeviceDefinitionFluentBuilder
pub fn delete_device_definition(&self) -> DeleteDeviceDefinitionFluentBuilder
Constructs a fluent builder for the DeleteDeviceDefinition
operation.
- The fluent builder is configurable:
device_definition_id(impl Into<String>)
/set_device_definition_id(Option<String>)
:
required: true
The ID of the device definition.
- On success, responds with
DeleteDeviceDefinitionOutput
- On failure, responds with
SdkError<DeleteDeviceDefinitionError>
source§impl Client
impl Client
sourcepub fn delete_function_definition(
&self,
) -> DeleteFunctionDefinitionFluentBuilder
pub fn delete_function_definition( &self, ) -> DeleteFunctionDefinitionFluentBuilder
Constructs a fluent builder for the DeleteFunctionDefinition
operation.
- The fluent builder is configurable:
function_definition_id(impl Into<String>)
/set_function_definition_id(Option<String>)
:
required: true
The ID of the Lambda function definition.
- On success, responds with
DeleteFunctionDefinitionOutput
- On failure, responds with
SdkError<DeleteFunctionDefinitionError>
source§impl Client
impl Client
sourcepub fn delete_group(&self) -> DeleteGroupFluentBuilder
pub fn delete_group(&self) -> DeleteGroupFluentBuilder
Constructs a fluent builder for the DeleteGroup
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
DeleteGroupOutput
- On failure, responds with
SdkError<DeleteGroupError>
source§impl Client
impl Client
sourcepub fn delete_logger_definition(&self) -> DeleteLoggerDefinitionFluentBuilder
pub fn delete_logger_definition(&self) -> DeleteLoggerDefinitionFluentBuilder
Constructs a fluent builder for the DeleteLoggerDefinition
operation.
- The fluent builder is configurable:
logger_definition_id(impl Into<String>)
/set_logger_definition_id(Option<String>)
:
required: true
The ID of the logger definition.
- On success, responds with
DeleteLoggerDefinitionOutput
- On failure, responds with
SdkError<DeleteLoggerDefinitionError>
source§impl Client
impl Client
sourcepub fn delete_resource_definition(
&self,
) -> DeleteResourceDefinitionFluentBuilder
pub fn delete_resource_definition( &self, ) -> DeleteResourceDefinitionFluentBuilder
Constructs a fluent builder for the DeleteResourceDefinition
operation.
- The fluent builder is configurable:
resource_definition_id(impl Into<String>)
/set_resource_definition_id(Option<String>)
:
required: true
The ID of the resource definition.
- On success, responds with
DeleteResourceDefinitionOutput
- On failure, responds with
SdkError<DeleteResourceDefinitionError>
source§impl Client
impl Client
sourcepub fn delete_subscription_definition(
&self,
) -> DeleteSubscriptionDefinitionFluentBuilder
pub fn delete_subscription_definition( &self, ) -> DeleteSubscriptionDefinitionFluentBuilder
Constructs a fluent builder for the DeleteSubscriptionDefinition
operation.
- The fluent builder is configurable:
subscription_definition_id(impl Into<String>)
/set_subscription_definition_id(Option<String>)
:
required: true
The ID of the subscription definition.
- On success, responds with
DeleteSubscriptionDefinitionOutput
- On failure, responds with
SdkError<DeleteSubscriptionDefinitionError>
source§impl Client
impl Client
sourcepub fn disassociate_role_from_group(
&self,
) -> DisassociateRoleFromGroupFluentBuilder
pub fn disassociate_role_from_group( &self, ) -> DisassociateRoleFromGroupFluentBuilder
Constructs a fluent builder for the DisassociateRoleFromGroup
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
DisassociateRoleFromGroupOutput
with field(s):disassociated_at(Option<String>)
: The time, in milliseconds since the epoch, when the role was disassociated from the group.
- On failure, responds with
SdkError<DisassociateRoleFromGroupError>
source§impl Client
impl Client
sourcepub fn disassociate_service_role_from_account(
&self,
) -> DisassociateServiceRoleFromAccountFluentBuilder
pub fn disassociate_service_role_from_account( &self, ) -> DisassociateServiceRoleFromAccountFluentBuilder
Constructs a fluent builder for the DisassociateServiceRoleFromAccount
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DisassociateServiceRoleFromAccountOutput
with field(s):disassociated_at(Option<String>)
: The time when the service role was disassociated from the account.
- On failure, responds with
SdkError<DisassociateServiceRoleFromAccountError>
source§impl Client
impl Client
sourcepub fn get_associated_role(&self) -> GetAssociatedRoleFluentBuilder
pub fn get_associated_role(&self) -> GetAssociatedRoleFluentBuilder
Constructs a fluent builder for the GetAssociatedRole
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
GetAssociatedRoleOutput
with field(s):associated_at(Option<String>)
: The time when the role was associated with the group.role_arn(Option<String>)
: The ARN of the role that is associated with the group.
- On failure, responds with
SdkError<GetAssociatedRoleError>
source§impl Client
impl Client
sourcepub fn get_bulk_deployment_status(&self) -> GetBulkDeploymentStatusFluentBuilder
pub fn get_bulk_deployment_status(&self) -> GetBulkDeploymentStatusFluentBuilder
Constructs a fluent builder for the GetBulkDeploymentStatus
operation.
- The fluent builder is configurable:
bulk_deployment_id(impl Into<String>)
/set_bulk_deployment_id(Option<String>)
:
required: true
The ID of the bulk deployment.
- On success, responds with
GetBulkDeploymentStatusOutput
with field(s):bulk_deployment_metrics(Option<BulkDeploymentMetrics>)
: Relevant metrics on input records processed during bulk deployment.bulk_deployment_status(Option<BulkDeploymentStatus>)
: The status of the bulk deployment.created_at(Option<String>)
: The time, in ISO format, when the deployment was created.error_details(Option<Vec::<ErrorDetail>>)
: Error detailserror_message(Option<String>)
: Error messagetags(Option<HashMap::<String, String>>)
: Tag(s) attached to the resource arn.
- On failure, responds with
SdkError<GetBulkDeploymentStatusError>
source§impl Client
impl Client
sourcepub fn get_connectivity_info(&self) -> GetConnectivityInfoFluentBuilder
pub fn get_connectivity_info(&self) -> GetConnectivityInfoFluentBuilder
Constructs a fluent builder for the GetConnectivityInfo
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: true
The thing name.
- On success, responds with
GetConnectivityInfoOutput
with field(s):connectivity_info(Option<Vec::<ConnectivityInfo>>)
: Connectivity info list.message(Option<String>)
: A message about the connectivity info request.
- On failure, responds with
SdkError<GetConnectivityInfoError>
source§impl Client
impl Client
sourcepub fn get_connector_definition(&self) -> GetConnectorDefinitionFluentBuilder
pub fn get_connector_definition(&self) -> GetConnectorDefinitionFluentBuilder
Constructs a fluent builder for the GetConnectorDefinition
operation.
- The fluent builder is configurable:
connector_definition_id(impl Into<String>)
/set_connector_definition_id(Option<String>)
:
required: true
The ID of the connector definition.
- On success, responds with
GetConnectorDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.tags(Option<HashMap::<String, String>>)
: Tag(s) attached to the resource arn.
- On failure, responds with
SdkError<GetConnectorDefinitionError>
source§impl Client
impl Client
sourcepub fn get_connector_definition_version(
&self,
) -> GetConnectorDefinitionVersionFluentBuilder
pub fn get_connector_definition_version( &self, ) -> GetConnectorDefinitionVersionFluentBuilder
Constructs a fluent builder for the GetConnectorDefinitionVersion
operation.
- The fluent builder is configurable:
connector_definition_id(impl Into<String>)
/set_connector_definition_id(Option<String>)
:
required: true
The ID of the connector definition.connector_definition_version_id(impl Into<String>)
/set_connector_definition_version_id(Option<String>)
:
required: true
The ID of the connector definition version. This value maps to the ’‘Version’’ property of the corresponding ’‘VersionInformation’’ object, which is returned by ’‘ListConnectorDefinitionVersions’’ requests. If the version is the last one that was associated with a connector definition, the value also maps to the ’‘LatestVersion’’ property of the corresponding ’‘DefinitionInformation’’ object.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
GetConnectorDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the connector definition version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the connector definition version was created.definition(Option<ConnectorDefinitionVersion>)
: Information about the connector definition version.id(Option<String>)
: The ID of the connector definition version.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.version(Option<String>)
: The version of the connector definition version.
- On failure, responds with
SdkError<GetConnectorDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn get_core_definition(&self) -> GetCoreDefinitionFluentBuilder
pub fn get_core_definition(&self) -> GetCoreDefinitionFluentBuilder
Constructs a fluent builder for the GetCoreDefinition
operation.
- The fluent builder is configurable:
core_definition_id(impl Into<String>)
/set_core_definition_id(Option<String>)
:
required: true
The ID of the core definition.
- On success, responds with
GetCoreDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.tags(Option<HashMap::<String, String>>)
: Tag(s) attached to the resource arn.
- On failure, responds with
SdkError<GetCoreDefinitionError>
source§impl Client
impl Client
sourcepub fn get_core_definition_version(
&self,
) -> GetCoreDefinitionVersionFluentBuilder
pub fn get_core_definition_version( &self, ) -> GetCoreDefinitionVersionFluentBuilder
Constructs a fluent builder for the GetCoreDefinitionVersion
operation.
- The fluent builder is configurable:
core_definition_id(impl Into<String>)
/set_core_definition_id(Option<String>)
:
required: true
The ID of the core definition.core_definition_version_id(impl Into<String>)
/set_core_definition_version_id(Option<String>)
:
required: true
The ID of the core definition version. This value maps to the ’‘Version’’ property of the corresponding ’‘VersionInformation’’ object, which is returned by ’‘ListCoreDefinitionVersions’’ requests. If the version is the last one that was associated with a core definition, the value also maps to the ’‘LatestVersion’’ property of the corresponding ’‘DefinitionInformation’’ object.
- On success, responds with
GetCoreDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the core definition version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the core definition version was created.definition(Option<CoreDefinitionVersion>)
: Information about the core definition version.id(Option<String>)
: The ID of the core definition version.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.version(Option<String>)
: The version of the core definition version.
- On failure, responds with
SdkError<GetCoreDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn get_deployment_status(&self) -> GetDeploymentStatusFluentBuilder
pub fn get_deployment_status(&self) -> GetDeploymentStatusFluentBuilder
Constructs a fluent builder for the GetDeploymentStatus
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: true
The ID of the deployment.group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
GetDeploymentStatusOutput
with field(s):deployment_status(Option<String>)
: The status of the deployment: ’‘InProgress’’, ’‘Building’’, ’‘Success’’, or ’‘Failure’’.deployment_type(Option<DeploymentType>)
: The type of the deployment.error_details(Option<Vec::<ErrorDetail>>)
: Error detailserror_message(Option<String>)
: Error messageupdated_at(Option<String>)
: The time, in milliseconds since the epoch, when the deployment status was updated.
- On failure, responds with
SdkError<GetDeploymentStatusError>
source§impl Client
impl Client
sourcepub fn get_device_definition(&self) -> GetDeviceDefinitionFluentBuilder
pub fn get_device_definition(&self) -> GetDeviceDefinitionFluentBuilder
Constructs a fluent builder for the GetDeviceDefinition
operation.
- The fluent builder is configurable:
device_definition_id(impl Into<String>)
/set_device_definition_id(Option<String>)
:
required: true
The ID of the device definition.
- On success, responds with
GetDeviceDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.tags(Option<HashMap::<String, String>>)
: Tag(s) attached to the resource arn.
- On failure, responds with
SdkError<GetDeviceDefinitionError>
source§impl Client
impl Client
sourcepub fn get_device_definition_version(
&self,
) -> GetDeviceDefinitionVersionFluentBuilder
pub fn get_device_definition_version( &self, ) -> GetDeviceDefinitionVersionFluentBuilder
Constructs a fluent builder for the GetDeviceDefinitionVersion
operation.
- The fluent builder is configurable:
device_definition_id(impl Into<String>)
/set_device_definition_id(Option<String>)
:
required: true
The ID of the device definition.device_definition_version_id(impl Into<String>)
/set_device_definition_version_id(Option<String>)
:
required: true
The ID of the device definition version. This value maps to the ’‘Version’’ property of the corresponding ’‘VersionInformation’’ object, which is returned by ’‘ListDeviceDefinitionVersions’’ requests. If the version is the last one that was associated with a device definition, the value also maps to the ’‘LatestVersion’’ property of the corresponding ’‘DefinitionInformation’’ object.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
GetDeviceDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the device definition version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the device definition version was created.definition(Option<DeviceDefinitionVersion>)
: Information about the device definition version.id(Option<String>)
: The ID of the device definition version.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.version(Option<String>)
: The version of the device definition version.
- On failure, responds with
SdkError<GetDeviceDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn get_function_definition(&self) -> GetFunctionDefinitionFluentBuilder
pub fn get_function_definition(&self) -> GetFunctionDefinitionFluentBuilder
Constructs a fluent builder for the GetFunctionDefinition
operation.
- The fluent builder is configurable:
function_definition_id(impl Into<String>)
/set_function_definition_id(Option<String>)
:
required: true
The ID of the Lambda function definition.
- On success, responds with
GetFunctionDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.tags(Option<HashMap::<String, String>>)
: Tag(s) attached to the resource arn.
- On failure, responds with
SdkError<GetFunctionDefinitionError>
source§impl Client
impl Client
sourcepub fn get_function_definition_version(
&self,
) -> GetFunctionDefinitionVersionFluentBuilder
pub fn get_function_definition_version( &self, ) -> GetFunctionDefinitionVersionFluentBuilder
Constructs a fluent builder for the GetFunctionDefinitionVersion
operation.
- The fluent builder is configurable:
function_definition_id(impl Into<String>)
/set_function_definition_id(Option<String>)
:
required: true
The ID of the Lambda function definition.function_definition_version_id(impl Into<String>)
/set_function_definition_version_id(Option<String>)
:
required: true
The ID of the function definition version. This value maps to the ’‘Version’’ property of the corresponding ’‘VersionInformation’’ object, which is returned by ’‘ListFunctionDefinitionVersions’’ requests. If the version is the last one that was associated with a function definition, the value also maps to the ’‘LatestVersion’’ property of the corresponding ’‘DefinitionInformation’’ object.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
GetFunctionDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the function definition version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the function definition version was created.definition(Option<FunctionDefinitionVersion>)
: Information on the definition.id(Option<String>)
: The ID of the function definition version.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.version(Option<String>)
: The version of the function definition version.
- On failure, responds with
SdkError<GetFunctionDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn get_group(&self) -> GetGroupFluentBuilder
pub fn get_group(&self) -> GetGroupFluentBuilder
Constructs a fluent builder for the GetGroup
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
GetGroupOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.tags(Option<HashMap::<String, String>>)
: Tag(s) attached to the resource arn.
- On failure, responds with
SdkError<GetGroupError>
source§impl Client
impl Client
Constructs a fluent builder for the GetGroupCertificateAuthority
operation.
- The fluent builder is configurable:
certificate_authority_id(impl Into<String>)
/set_certificate_authority_id(Option<String>)
:
required: true
The ID of the certificate authority.group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
GetGroupCertificateAuthorityOutput
with field(s):group_certificate_authority_arn(Option<String>)
: The ARN of the certificate authority for the group.group_certificate_authority_id(Option<String>)
: The ID of the certificate authority for the group.pem_encoded_certificate(Option<String>)
: The PEM encoded certificate for the group.
- On failure, responds with
SdkError<GetGroupCertificateAuthorityError>
source§impl Client
impl Client
sourcepub fn get_group_certificate_configuration(
&self,
) -> GetGroupCertificateConfigurationFluentBuilder
pub fn get_group_certificate_configuration( &self, ) -> GetGroupCertificateConfigurationFluentBuilder
Constructs a fluent builder for the GetGroupCertificateConfiguration
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
GetGroupCertificateConfigurationOutput
with field(s):certificate_authority_expiry_in_milliseconds(Option<String>)
: The amount of time remaining before the certificate authority expires, in milliseconds.certificate_expiry_in_milliseconds(Option<String>)
: The amount of time remaining before the certificate expires, in milliseconds.group_id(Option<String>)
: The ID of the group certificate configuration.
- On failure, responds with
SdkError<GetGroupCertificateConfigurationError>
source§impl Client
impl Client
sourcepub fn get_group_version(&self) -> GetGroupVersionFluentBuilder
pub fn get_group_version(&self) -> GetGroupVersionFluentBuilder
Constructs a fluent builder for the GetGroupVersion
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.group_version_id(impl Into<String>)
/set_group_version_id(Option<String>)
:
required: true
The ID of the group version. This value maps to the ’‘Version’’ property of the corresponding ’‘VersionInformation’’ object, which is returned by ’‘ListGroupVersions’’ requests. If the version is the last one that was associated with a group, the value also maps to the ’‘LatestVersion’’ property of the corresponding ’‘GroupInformation’’ object.
- On success, responds with
GetGroupVersionOutput
with field(s):arn(Option<String>)
: The ARN of the group version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the group version was created.definition(Option<GroupVersion>)
: Information about the group version definition.id(Option<String>)
: The ID of the group that the version is associated with.version(Option<String>)
: The ID of the group version.
- On failure, responds with
SdkError<GetGroupVersionError>
source§impl Client
impl Client
sourcepub fn get_logger_definition(&self) -> GetLoggerDefinitionFluentBuilder
pub fn get_logger_definition(&self) -> GetLoggerDefinitionFluentBuilder
Constructs a fluent builder for the GetLoggerDefinition
operation.
- The fluent builder is configurable:
logger_definition_id(impl Into<String>)
/set_logger_definition_id(Option<String>)
:
required: true
The ID of the logger definition.
- On success, responds with
GetLoggerDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.tags(Option<HashMap::<String, String>>)
: Tag(s) attached to the resource arn.
- On failure, responds with
SdkError<GetLoggerDefinitionError>
source§impl Client
impl Client
sourcepub fn get_logger_definition_version(
&self,
) -> GetLoggerDefinitionVersionFluentBuilder
pub fn get_logger_definition_version( &self, ) -> GetLoggerDefinitionVersionFluentBuilder
Constructs a fluent builder for the GetLoggerDefinitionVersion
operation.
- The fluent builder is configurable:
logger_definition_id(impl Into<String>)
/set_logger_definition_id(Option<String>)
:
required: true
The ID of the logger definition.logger_definition_version_id(impl Into<String>)
/set_logger_definition_version_id(Option<String>)
:
required: true
The ID of the logger definition version. This value maps to the ’‘Version’’ property of the corresponding ’‘VersionInformation’’ object, which is returned by ’‘ListLoggerDefinitionVersions’’ requests. If the version is the last one that was associated with a logger definition, the value also maps to the ’‘LatestVersion’’ property of the corresponding ’‘DefinitionInformation’’ object.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
GetLoggerDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the logger definition version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the logger definition version was created.definition(Option<LoggerDefinitionVersion>)
: Information about the logger definition version.id(Option<String>)
: The ID of the logger definition version.version(Option<String>)
: The version of the logger definition version.
- On failure, responds with
SdkError<GetLoggerDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn get_resource_definition(&self) -> GetResourceDefinitionFluentBuilder
pub fn get_resource_definition(&self) -> GetResourceDefinitionFluentBuilder
Constructs a fluent builder for the GetResourceDefinition
operation.
- The fluent builder is configurable:
resource_definition_id(impl Into<String>)
/set_resource_definition_id(Option<String>)
:
required: true
The ID of the resource definition.
- On success, responds with
GetResourceDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.tags(Option<HashMap::<String, String>>)
: Tag(s) attached to the resource arn.
- On failure, responds with
SdkError<GetResourceDefinitionError>
source§impl Client
impl Client
sourcepub fn get_resource_definition_version(
&self,
) -> GetResourceDefinitionVersionFluentBuilder
pub fn get_resource_definition_version( &self, ) -> GetResourceDefinitionVersionFluentBuilder
Constructs a fluent builder for the GetResourceDefinitionVersion
operation.
- The fluent builder is configurable:
resource_definition_id(impl Into<String>)
/set_resource_definition_id(Option<String>)
:
required: true
The ID of the resource definition.resource_definition_version_id(impl Into<String>)
/set_resource_definition_version_id(Option<String>)
:
required: true
The ID of the resource definition version. This value maps to the ’‘Version’’ property of the corresponding ’‘VersionInformation’’ object, which is returned by ’‘ListResourceDefinitionVersions’’ requests. If the version is the last one that was associated with a resource definition, the value also maps to the ’‘LatestVersion’’ property of the corresponding ’‘DefinitionInformation’’ object.
- On success, responds with
GetResourceDefinitionVersionOutput
with field(s):arn(Option<String>)
: Arn of the resource definition version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the resource definition version was created.definition(Option<ResourceDefinitionVersion>)
: Information about the definition.id(Option<String>)
: The ID of the resource definition version.version(Option<String>)
: The version of the resource definition version.
- On failure, responds with
SdkError<GetResourceDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn get_service_role_for_account(
&self,
) -> GetServiceRoleForAccountFluentBuilder
pub fn get_service_role_for_account( &self, ) -> GetServiceRoleForAccountFluentBuilder
Constructs a fluent builder for the GetServiceRoleForAccount
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetServiceRoleForAccountOutput
with field(s):associated_at(Option<String>)
: The time when the service role was associated with the account.role_arn(Option<String>)
: The ARN of the role which is associated with the account.
- On failure, responds with
SdkError<GetServiceRoleForAccountError>
source§impl Client
impl Client
sourcepub fn get_subscription_definition(
&self,
) -> GetSubscriptionDefinitionFluentBuilder
pub fn get_subscription_definition( &self, ) -> GetSubscriptionDefinitionFluentBuilder
Constructs a fluent builder for the GetSubscriptionDefinition
operation.
- The fluent builder is configurable:
subscription_definition_id(impl Into<String>)
/set_subscription_definition_id(Option<String>)
:
required: true
The ID of the subscription definition.
- On success, responds with
GetSubscriptionDefinitionOutput
with field(s):arn(Option<String>)
: The ARN of the definition.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was created.id(Option<String>)
: The ID of the definition.last_updated_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the definition was last updated.latest_version(Option<String>)
: The ID of the latest version associated with the definition.latest_version_arn(Option<String>)
: The ARN of the latest version associated with the definition.name(Option<String>)
: The name of the definition.tags(Option<HashMap::<String, String>>)
: Tag(s) attached to the resource arn.
- On failure, responds with
SdkError<GetSubscriptionDefinitionError>
source§impl Client
impl Client
sourcepub fn get_subscription_definition_version(
&self,
) -> GetSubscriptionDefinitionVersionFluentBuilder
pub fn get_subscription_definition_version( &self, ) -> GetSubscriptionDefinitionVersionFluentBuilder
Constructs a fluent builder for the GetSubscriptionDefinitionVersion
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.subscription_definition_id(impl Into<String>)
/set_subscription_definition_id(Option<String>)
:
required: true
The ID of the subscription definition.subscription_definition_version_id(impl Into<String>)
/set_subscription_definition_version_id(Option<String>)
:
required: true
The ID of the subscription definition version. This value maps to the ’‘Version’’ property of the corresponding ’‘VersionInformation’’ object, which is returned by ’‘ListSubscriptionDefinitionVersions’’ requests. If the version is the last one that was associated with a subscription definition, the value also maps to the ’‘LatestVersion’’ property of the corresponding ’‘DefinitionInformation’’ object.
- On success, responds with
GetSubscriptionDefinitionVersionOutput
with field(s):arn(Option<String>)
: The ARN of the subscription definition version.creation_timestamp(Option<String>)
: The time, in milliseconds since the epoch, when the subscription definition version was created.definition(Option<SubscriptionDefinitionVersion>)
: Information about the subscription definition version.id(Option<String>)
: The ID of the subscription definition version.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.version(Option<String>)
: The version of the subscription definition version.
- On failure, responds with
SdkError<GetSubscriptionDefinitionVersionError>
source§impl Client
impl Client
sourcepub fn get_thing_runtime_configuration(
&self,
) -> GetThingRuntimeConfigurationFluentBuilder
pub fn get_thing_runtime_configuration( &self, ) -> GetThingRuntimeConfigurationFluentBuilder
Constructs a fluent builder for the GetThingRuntimeConfiguration
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: true
The thing name.
- On success, responds with
GetThingRuntimeConfigurationOutput
with field(s):runtime_configuration(Option<RuntimeConfiguration>)
: Runtime configuration for a thing.
- On failure, responds with
SdkError<GetThingRuntimeConfigurationError>
source§impl Client
impl Client
sourcepub fn list_bulk_deployment_detailed_reports(
&self,
) -> ListBulkDeploymentDetailedReportsFluentBuilder
pub fn list_bulk_deployment_detailed_reports( &self, ) -> ListBulkDeploymentDetailedReportsFluentBuilder
Constructs a fluent builder for the ListBulkDeploymentDetailedReports
operation.
- The fluent builder is configurable:
bulk_deployment_id(impl Into<String>)
/set_bulk_deployment_id(Option<String>)
:
required: true
The ID of the bulk deployment.max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListBulkDeploymentDetailedReportsOutput
with field(s):deployments(Option<Vec::<BulkDeploymentResult>>)
: A list of the individual group deployments in the bulk deployment operation.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListBulkDeploymentDetailedReportsError>
source§impl Client
impl Client
sourcepub fn list_bulk_deployments(&self) -> ListBulkDeploymentsFluentBuilder
pub fn list_bulk_deployments(&self) -> ListBulkDeploymentsFluentBuilder
Constructs a fluent builder for the ListBulkDeployments
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListBulkDeploymentsOutput
with field(s):bulk_deployments(Option<Vec::<BulkDeployment>>)
: A list of bulk deployments.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListBulkDeploymentsError>
source§impl Client
impl Client
sourcepub fn list_connector_definition_versions(
&self,
) -> ListConnectorDefinitionVersionsFluentBuilder
pub fn list_connector_definition_versions( &self, ) -> ListConnectorDefinitionVersionsFluentBuilder
Constructs a fluent builder for the ListConnectorDefinitionVersions
operation.
- The fluent builder is configurable:
connector_definition_id(impl Into<String>)
/set_connector_definition_id(Option<String>)
:
required: true
The ID of the connector definition.max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListConnectorDefinitionVersionsOutput
with field(s):next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.versions(Option<Vec::<VersionInformation>>)
: Information about a version.
- On failure, responds with
SdkError<ListConnectorDefinitionVersionsError>
source§impl Client
impl Client
sourcepub fn list_connector_definitions(
&self,
) -> ListConnectorDefinitionsFluentBuilder
pub fn list_connector_definitions( &self, ) -> ListConnectorDefinitionsFluentBuilder
Constructs a fluent builder for the ListConnectorDefinitions
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListConnectorDefinitionsOutput
with field(s):definitions(Option<Vec::<DefinitionInformation>>)
: Information about a definition.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListConnectorDefinitionsError>
source§impl Client
impl Client
sourcepub fn list_core_definition_versions(
&self,
) -> ListCoreDefinitionVersionsFluentBuilder
pub fn list_core_definition_versions( &self, ) -> ListCoreDefinitionVersionsFluentBuilder
Constructs a fluent builder for the ListCoreDefinitionVersions
operation.
- The fluent builder is configurable:
core_definition_id(impl Into<String>)
/set_core_definition_id(Option<String>)
:
required: true
The ID of the core definition.max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListCoreDefinitionVersionsOutput
with field(s):next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.versions(Option<Vec::<VersionInformation>>)
: Information about a version.
- On failure, responds with
SdkError<ListCoreDefinitionVersionsError>
source§impl Client
impl Client
sourcepub fn list_core_definitions(&self) -> ListCoreDefinitionsFluentBuilder
pub fn list_core_definitions(&self) -> ListCoreDefinitionsFluentBuilder
Constructs a fluent builder for the ListCoreDefinitions
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListCoreDefinitionsOutput
with field(s):definitions(Option<Vec::<DefinitionInformation>>)
: Information about a definition.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListCoreDefinitionsError>
source§impl Client
impl Client
sourcepub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
pub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
Constructs a fluent builder for the ListDeployments
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListDeploymentsOutput
with field(s):deployments(Option<Vec::<Deployment>>)
: A list of deployments for the requested groups.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListDeploymentsError>
source§impl Client
impl Client
sourcepub fn list_device_definition_versions(
&self,
) -> ListDeviceDefinitionVersionsFluentBuilder
pub fn list_device_definition_versions( &self, ) -> ListDeviceDefinitionVersionsFluentBuilder
Constructs a fluent builder for the ListDeviceDefinitionVersions
operation.
- The fluent builder is configurable:
device_definition_id(impl Into<String>)
/set_device_definition_id(Option<String>)
:
required: true
The ID of the device definition.max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListDeviceDefinitionVersionsOutput
with field(s):next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.versions(Option<Vec::<VersionInformation>>)
: Information about a version.
- On failure, responds with
SdkError<ListDeviceDefinitionVersionsError>
source§impl Client
impl Client
sourcepub fn list_device_definitions(&self) -> ListDeviceDefinitionsFluentBuilder
pub fn list_device_definitions(&self) -> ListDeviceDefinitionsFluentBuilder
Constructs a fluent builder for the ListDeviceDefinitions
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListDeviceDefinitionsOutput
with field(s):definitions(Option<Vec::<DefinitionInformation>>)
: Information about a definition.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListDeviceDefinitionsError>
source§impl Client
impl Client
sourcepub fn list_function_definition_versions(
&self,
) -> ListFunctionDefinitionVersionsFluentBuilder
pub fn list_function_definition_versions( &self, ) -> ListFunctionDefinitionVersionsFluentBuilder
Constructs a fluent builder for the ListFunctionDefinitionVersions
operation.
- The fluent builder is configurable:
function_definition_id(impl Into<String>)
/set_function_definition_id(Option<String>)
:
required: true
The ID of the Lambda function definition.max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListFunctionDefinitionVersionsOutput
with field(s):next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.versions(Option<Vec::<VersionInformation>>)
: Information about a version.
- On failure, responds with
SdkError<ListFunctionDefinitionVersionsError>
source§impl Client
impl Client
sourcepub fn list_function_definitions(&self) -> ListFunctionDefinitionsFluentBuilder
pub fn list_function_definitions(&self) -> ListFunctionDefinitionsFluentBuilder
Constructs a fluent builder for the ListFunctionDefinitions
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListFunctionDefinitionsOutput
with field(s):definitions(Option<Vec::<DefinitionInformation>>)
: Information about a definition.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListFunctionDefinitionsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListGroupCertificateAuthorities
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
ListGroupCertificateAuthoritiesOutput
with field(s):group_certificate_authorities(Option<Vec::<GroupCertificateAuthorityProperties>>)
: A list of certificate authorities associated with the group.
- On failure, responds with
SdkError<ListGroupCertificateAuthoritiesError>
source§impl Client
impl Client
sourcepub fn list_group_versions(&self) -> ListGroupVersionsFluentBuilder
pub fn list_group_versions(&self) -> ListGroupVersionsFluentBuilder
Constructs a fluent builder for the ListGroupVersions
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListGroupVersionsOutput
with field(s):next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.versions(Option<Vec::<VersionInformation>>)
: Information about a version.
- On failure, responds with
SdkError<ListGroupVersionsError>
source§impl Client
impl Client
sourcepub fn list_groups(&self) -> ListGroupsFluentBuilder
pub fn list_groups(&self) -> ListGroupsFluentBuilder
Constructs a fluent builder for the ListGroups
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListGroupsOutput
with field(s):groups(Option<Vec::<GroupInformation>>)
: Information about a group.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListGroupsError>
source§impl Client
impl Client
sourcepub fn list_logger_definition_versions(
&self,
) -> ListLoggerDefinitionVersionsFluentBuilder
pub fn list_logger_definition_versions( &self, ) -> ListLoggerDefinitionVersionsFluentBuilder
Constructs a fluent builder for the ListLoggerDefinitionVersions
operation.
- The fluent builder is configurable:
logger_definition_id(impl Into<String>)
/set_logger_definition_id(Option<String>)
:
required: true
The ID of the logger definition.max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListLoggerDefinitionVersionsOutput
with field(s):next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.versions(Option<Vec::<VersionInformation>>)
: Information about a version.
- On failure, responds with
SdkError<ListLoggerDefinitionVersionsError>
source§impl Client
impl Client
sourcepub fn list_logger_definitions(&self) -> ListLoggerDefinitionsFluentBuilder
pub fn list_logger_definitions(&self) -> ListLoggerDefinitionsFluentBuilder
Constructs a fluent builder for the ListLoggerDefinitions
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListLoggerDefinitionsOutput
with field(s):definitions(Option<Vec::<DefinitionInformation>>)
: Information about a definition.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListLoggerDefinitionsError>
source§impl Client
impl Client
sourcepub fn list_resource_definition_versions(
&self,
) -> ListResourceDefinitionVersionsFluentBuilder
pub fn list_resource_definition_versions( &self, ) -> ListResourceDefinitionVersionsFluentBuilder
Constructs a fluent builder for the ListResourceDefinitionVersions
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.resource_definition_id(impl Into<String>)
/set_resource_definition_id(Option<String>)
:
required: true
The ID of the resource definition.
- On success, responds with
ListResourceDefinitionVersionsOutput
with field(s):next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.versions(Option<Vec::<VersionInformation>>)
: Information about a version.
- On failure, responds with
SdkError<ListResourceDefinitionVersionsError>
source§impl Client
impl Client
sourcepub fn list_resource_definitions(&self) -> ListResourceDefinitionsFluentBuilder
pub fn list_resource_definitions(&self) -> ListResourceDefinitionsFluentBuilder
Constructs a fluent builder for the ListResourceDefinitions
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListResourceDefinitionsOutput
with field(s):definitions(Option<Vec::<DefinitionInformation>>)
: Information about a definition.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListResourceDefinitionsError>
source§impl Client
impl Client
sourcepub fn list_subscription_definition_versions(
&self,
) -> ListSubscriptionDefinitionVersionsFluentBuilder
pub fn list_subscription_definition_versions( &self, ) -> ListSubscriptionDefinitionVersionsFluentBuilder
Constructs a fluent builder for the ListSubscriptionDefinitionVersions
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.subscription_definition_id(impl Into<String>)
/set_subscription_definition_id(Option<String>)
:
required: true
The ID of the subscription definition.
- On success, responds with
ListSubscriptionDefinitionVersionsOutput
with field(s):next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.versions(Option<Vec::<VersionInformation>>)
: Information about a version.
- On failure, responds with
SdkError<ListSubscriptionDefinitionVersionsError>
source§impl Client
impl Client
sourcepub fn list_subscription_definitions(
&self,
) -> ListSubscriptionDefinitionsFluentBuilder
pub fn list_subscription_definitions( &self, ) -> ListSubscriptionDefinitionsFluentBuilder
Constructs a fluent builder for the ListSubscriptionDefinitions
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: false
The maximum number of results to be returned per request.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
The token for the next set of results, or ’‘null’’ if there are no additional results.
- On success, responds with
ListSubscriptionDefinitionsOutput
with field(s):definitions(Option<Vec::<DefinitionInformation>>)
: Information about a definition.next_token(Option<String>)
: The token for the next set of results, or ’‘null’’ if there are no additional results.
- On failure, responds with
SdkError<ListSubscriptionDefinitionsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
: The key-value pair for the resource tag.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn reset_deployments(&self) -> ResetDeploymentsFluentBuilder
pub fn reset_deployments(&self) -> ResetDeploymentsFluentBuilder
Constructs a fluent builder for the ResetDeployments
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.force(bool)
/set_force(Option<bool>)
:
required: false
If true, performs a best-effort only core reset.group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
ResetDeploymentsOutput
with field(s):deployment_arn(Option<String>)
: The ARN of the deployment.deployment_id(Option<String>)
: The ID of the deployment.
- On failure, responds with
SdkError<ResetDeploymentsError>
source§impl Client
impl Client
sourcepub fn start_bulk_deployment(&self) -> StartBulkDeploymentFluentBuilder
pub fn start_bulk_deployment(&self) -> StartBulkDeploymentFluentBuilder
Constructs a fluent builder for the StartBulkDeployment
operation.
- The fluent builder is configurable:
amzn_client_token(impl Into<String>)
/set_amzn_client_token(Option<String>)
:
required: false
A client token used to correlate requests and responses.execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: true
The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ’‘greengrass:CreateDeployment’’ action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.input_file_uri(impl Into<String>)
/set_input_file_uri(Option<String>)
:
required: true
The URI of the input file contained in the S3 bucket. The execution role must have ’‘getObject’’ permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ’‘NewDeployment’’ deployment types.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
Tag(s) to add to the new resource.
- On success, responds with
StartBulkDeploymentOutput
with field(s):bulk_deployment_arn(Option<String>)
: The ARN of the bulk deployment.bulk_deployment_id(Option<String>)
: The ID of the bulk deployment.
- On failure, responds with
SdkError<StartBulkDeploymentError>
source§impl Client
impl Client
sourcepub fn stop_bulk_deployment(&self) -> StopBulkDeploymentFluentBuilder
pub fn stop_bulk_deployment(&self) -> StopBulkDeploymentFluentBuilder
Constructs a fluent builder for the StopBulkDeployment
operation.
- The fluent builder is configurable:
bulk_deployment_id(impl Into<String>)
/set_bulk_deployment_id(Option<String>)
:
required: true
The ID of the bulk deployment.
- On success, responds with
StopBulkDeploymentOutput
- On failure, responds with
SdkError<StopBulkDeploymentError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the resource.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: false
The key-value pair for the resource tag.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the resource.tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: true
An array of tag keys to delete
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_connectivity_info(&self) -> UpdateConnectivityInfoFluentBuilder
pub fn update_connectivity_info(&self) -> UpdateConnectivityInfoFluentBuilder
Constructs a fluent builder for the UpdateConnectivityInfo
operation.
- The fluent builder is configurable:
connectivity_info(ConnectivityInfo)
/set_connectivity_info(Option<Vec::<ConnectivityInfo>>)
:
required: false
A list of connectivity info.thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: true
The thing name.
- On success, responds with
UpdateConnectivityInfoOutput
with field(s):message(Option<String>)
: A message about the connectivity info update request.version(Option<String>)
: The new version of the connectivity info.
- On failure, responds with
SdkError<UpdateConnectivityInfoError>
source§impl Client
impl Client
sourcepub fn update_connector_definition(
&self,
) -> UpdateConnectorDefinitionFluentBuilder
pub fn update_connector_definition( &self, ) -> UpdateConnectorDefinitionFluentBuilder
Constructs a fluent builder for the UpdateConnectorDefinition
operation.
- The fluent builder is configurable:
connector_definition_id(impl Into<String>)
/set_connector_definition_id(Option<String>)
:
required: true
The ID of the connector definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the definition.
- On success, responds with
UpdateConnectorDefinitionOutput
- On failure, responds with
SdkError<UpdateConnectorDefinitionError>
source§impl Client
impl Client
sourcepub fn update_core_definition(&self) -> UpdateCoreDefinitionFluentBuilder
pub fn update_core_definition(&self) -> UpdateCoreDefinitionFluentBuilder
Constructs a fluent builder for the UpdateCoreDefinition
operation.
- The fluent builder is configurable:
core_definition_id(impl Into<String>)
/set_core_definition_id(Option<String>)
:
required: true
The ID of the core definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the definition.
- On success, responds with
UpdateCoreDefinitionOutput
- On failure, responds with
SdkError<UpdateCoreDefinitionError>
source§impl Client
impl Client
sourcepub fn update_device_definition(&self) -> UpdateDeviceDefinitionFluentBuilder
pub fn update_device_definition(&self) -> UpdateDeviceDefinitionFluentBuilder
Constructs a fluent builder for the UpdateDeviceDefinition
operation.
- The fluent builder is configurable:
device_definition_id(impl Into<String>)
/set_device_definition_id(Option<String>)
:
required: true
The ID of the device definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the definition.
- On success, responds with
UpdateDeviceDefinitionOutput
- On failure, responds with
SdkError<UpdateDeviceDefinitionError>
source§impl Client
impl Client
sourcepub fn update_function_definition(
&self,
) -> UpdateFunctionDefinitionFluentBuilder
pub fn update_function_definition( &self, ) -> UpdateFunctionDefinitionFluentBuilder
Constructs a fluent builder for the UpdateFunctionDefinition
operation.
- The fluent builder is configurable:
function_definition_id(impl Into<String>)
/set_function_definition_id(Option<String>)
:
required: true
The ID of the Lambda function definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the definition.
- On success, responds with
UpdateFunctionDefinitionOutput
- On failure, responds with
SdkError<UpdateFunctionDefinitionError>
source§impl Client
impl Client
sourcepub fn update_group(&self) -> UpdateGroupFluentBuilder
pub fn update_group(&self) -> UpdateGroupFluentBuilder
Constructs a fluent builder for the UpdateGroup
operation.
- The fluent builder is configurable:
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the definition.
- On success, responds with
UpdateGroupOutput
- On failure, responds with
SdkError<UpdateGroupError>
source§impl Client
impl Client
sourcepub fn update_group_certificate_configuration(
&self,
) -> UpdateGroupCertificateConfigurationFluentBuilder
pub fn update_group_certificate_configuration( &self, ) -> UpdateGroupCertificateConfigurationFluentBuilder
Constructs a fluent builder for the UpdateGroupCertificateConfiguration
operation.
- The fluent builder is configurable:
certificate_expiry_in_milliseconds(impl Into<String>)
/set_certificate_expiry_in_milliseconds(Option<String>)
:
required: false
The amount of time remaining before the certificate expires, in milliseconds.group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: true
The ID of the Greengrass group.
- On success, responds with
UpdateGroupCertificateConfigurationOutput
with field(s):certificate_authority_expiry_in_milliseconds(Option<String>)
: The amount of time remaining before the certificate authority expires, in milliseconds.certificate_expiry_in_milliseconds(Option<String>)
: The amount of time remaining before the certificate expires, in milliseconds.group_id(Option<String>)
: The ID of the group certificate configuration.
- On failure, responds with
SdkError<UpdateGroupCertificateConfigurationError>
source§impl Client
impl Client
sourcepub fn update_logger_definition(&self) -> UpdateLoggerDefinitionFluentBuilder
pub fn update_logger_definition(&self) -> UpdateLoggerDefinitionFluentBuilder
Constructs a fluent builder for the UpdateLoggerDefinition
operation.
- The fluent builder is configurable:
logger_definition_id(impl Into<String>)
/set_logger_definition_id(Option<String>)
:
required: true
The ID of the logger definition.name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the definition.
- On success, responds with
UpdateLoggerDefinitionOutput
- On failure, responds with
SdkError<UpdateLoggerDefinitionError>
source§impl Client
impl Client
sourcepub fn update_resource_definition(
&self,
) -> UpdateResourceDefinitionFluentBuilder
pub fn update_resource_definition( &self, ) -> UpdateResourceDefinitionFluentBuilder
Constructs a fluent builder for the UpdateResourceDefinition
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the definition.resource_definition_id(impl Into<String>)
/set_resource_definition_id(Option<String>)
:
required: true
The ID of the resource definition.
- On success, responds with
UpdateResourceDefinitionOutput
- On failure, responds with
SdkError<UpdateResourceDefinitionError>
source§impl Client
impl Client
sourcepub fn update_subscription_definition(
&self,
) -> UpdateSubscriptionDefinitionFluentBuilder
pub fn update_subscription_definition( &self, ) -> UpdateSubscriptionDefinitionFluentBuilder
Constructs a fluent builder for the UpdateSubscriptionDefinition
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: false
The name of the definition.subscription_definition_id(impl Into<String>)
/set_subscription_definition_id(Option<String>)
:
required: true
The ID of the subscription definition.
- On success, responds with
UpdateSubscriptionDefinitionOutput
- On failure, responds with
SdkError<UpdateSubscriptionDefinitionError>
source§impl Client
impl Client
sourcepub fn update_thing_runtime_configuration(
&self,
) -> UpdateThingRuntimeConfigurationFluentBuilder
pub fn update_thing_runtime_configuration( &self, ) -> UpdateThingRuntimeConfigurationFluentBuilder
Constructs a fluent builder for the UpdateThingRuntimeConfiguration
operation.
- The fluent builder is configurable:
telemetry_configuration(TelemetryConfigurationUpdate)
/set_telemetry_configuration(Option<TelemetryConfigurationUpdate>)
:
required: false
Configuration for telemetry service.thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: true
The thing name.
- On success, responds with
UpdateThingRuntimeConfigurationOutput
- On failure, responds with
SdkError<UpdateThingRuntimeConfigurationError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more