iotmanagedintegrations/aws.sdk.kotlin.services.iotmanagedintegrations/IotManagedIntegrationsClient

IotManagedIntegrationsClient

interface IotManagedIntegrationsClient : SdkClient

Managed integrations is a feature of AWS IoT Device Management that enables developers to quickly build innovative IoT solutions. Customers can use managed integrations to automate device setup workflows and support interoperability across many devices, regardless of device vendor or connectivity protocol. This allows developers to use a single user-interface to control, manage, and operate a range of devices.

Types

Builder

class Builder : AbstractSdkClientBuilder<IotManagedIntegrationsClient.Config, IotManagedIntegrationsClient.Config.Builder, IotManagedIntegrationsClient>

Companion

object Companion : AbstractAwsSdkClientFactory<IotManagedIntegrationsClient.Config, IotManagedIntegrationsClient.Config.Builder, IotManagedIntegrationsClient, IotManagedIntegrationsClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: IotManagedIntegrationsClient.Config

IotManagedIntegrationsClient's configuration

Functions

createAccountAssociation

abstract suspend fun createAccountAssociation(input: CreateAccountAssociationRequest): CreateAccountAssociationResponse

Creates a new account association via the destination id.

createCloudConnector

abstract suspend fun createCloudConnector(input: CreateCloudConnectorRequest): CreateCloudConnectorResponse

Creates a C2C (cloud-to-cloud) connector.

createConnectorDestination

abstract suspend fun createConnectorDestination(input: CreateConnectorDestinationRequest): CreateConnectorDestinationResponse

Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.

createCredentialLocker

abstract suspend fun createCredentialLocker(input: CreateCredentialLockerRequest = CreateCredentialLockerRequest { }): CreateCredentialLockerResponse

Create a product credential locker. This operation will trigger the creation of all the manufacturing resources including the Wi-Fi setup key pair and device certificate.

createDestination

abstract suspend fun createDestination(input: CreateDestinationRequest): CreateDestinationResponse

Create a destination. IoT managed integrations uses the destination to determine where to deliver notifications for a device.

createEventLogConfiguration

abstract suspend fun createEventLogConfiguration(input: CreateEventLogConfigurationRequest): CreateEventLogConfigurationResponse

Set the event log configuration for the account, resource type, or specific resource.

createManagedThing

abstract suspend fun createManagedThing(input: CreateManagedThingRequest): CreateManagedThingResponse

Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a protocol-specific format.

createNotificationConfiguration

abstract suspend fun createNotificationConfiguration(input: CreateNotificationConfigurationRequest): CreateNotificationConfigurationResponse

Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.

createOtaTask

abstract suspend fun createOtaTask(input: CreateOtaTaskRequest): CreateOtaTaskResponse

Create an over-the-air (OTA) task to update a device.

createOtaTaskConfiguration

abstract suspend fun createOtaTaskConfiguration(input: CreateOtaTaskConfigurationRequest = CreateOtaTaskConfigurationRequest { }): CreateOtaTaskConfigurationResponse

Create a configuraiton for the over-the-air (OTA) task.

createProvisioningProfile

abstract suspend fun createProvisioningProfile(input: CreateProvisioningProfileRequest): CreateProvisioningProfileResponse

Create a provisioning profile for a device to execute the provisioning flows using a provisioning template. The provisioning template is a document that defines the set of resources and policies applied to a device during the provisioning process.

deleteAccountAssociation

abstract suspend fun deleteAccountAssociation(input: DeleteAccountAssociationRequest): DeleteAccountAssociationResponse

Remove a third party account and related devices from an end user.

deleteCloudConnector

abstract suspend fun deleteCloudConnector(input: DeleteCloudConnectorRequest): DeleteCloudConnectorResponse

Delete a cloud connector.

deleteConnectorDestination

abstract suspend fun deleteConnectorDestination(input: DeleteConnectorDestinationRequest): DeleteConnectorDestinationResponse

Delete a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.

deleteCredentialLocker

abstract suspend fun deleteCredentialLocker(input: DeleteCredentialLockerRequest): DeleteCredentialLockerResponse

Delete a credential locker.

deleteDestination

abstract suspend fun deleteDestination(input: DeleteDestinationRequest): DeleteDestinationResponse

Deletes a customer-managed destination specified by id.

deleteEventLogConfiguration

abstract suspend fun deleteEventLogConfiguration(input: DeleteEventLogConfigurationRequest): DeleteEventLogConfigurationResponse

Delete an event log configuration.

deleteManagedThing

abstract suspend fun deleteManagedThing(input: DeleteManagedThingRequest): DeleteManagedThingResponse

Delete a managed thing. If a controller is deleted, all of the devices connected to it will have their status changed to PENDING. It is not possible to remove a cloud device.

deleteNotificationConfiguration

abstract suspend fun deleteNotificationConfiguration(input: DeleteNotificationConfigurationRequest): DeleteNotificationConfigurationResponse

Deletes a notification configuration.

deleteOtaTask

abstract suspend fun deleteOtaTask(input: DeleteOtaTaskRequest): DeleteOtaTaskResponse

Delete the over-the-air (OTA) task.

deleteOtaTaskConfiguration

abstract suspend fun deleteOtaTaskConfiguration(input: DeleteOtaTaskConfigurationRequest): DeleteOtaTaskConfigurationResponse

Delete the over-the-air (OTA) task configuration.

deleteProvisioningProfile

abstract suspend fun deleteProvisioningProfile(input: DeleteProvisioningProfileRequest): DeleteProvisioningProfileResponse

Delete a provisioning profile.

deregisterAccountAssociation

abstract suspend fun deregisterAccountAssociation(input: DeregisterAccountAssociationRequest): DeregisterAccountAssociationResponse

Deregisters an account association, removing the connection between a managed thing and a third-party account.

getAccountAssociation

abstract suspend fun getAccountAssociation(input: GetAccountAssociationRequest): GetAccountAssociationResponse

Get an account association for an Amazon Web Services account linked to a customer-managed destination.

getCloudConnector

abstract suspend fun getCloudConnector(input: GetCloudConnectorRequest): GetCloudConnectorResponse

Gets all the information about a connector for a connector developer.

getConnectorDestination

abstract suspend fun getConnectorDestination(input: GetConnectorDestinationRequest): GetConnectorDestinationResponse

Get a connector destination of a cloud-to-cloud (C2C) connector connecting to a customer's Amazon Web Services account.

getCredentialLocker

abstract suspend fun getCredentialLocker(input: GetCredentialLockerRequest): GetCredentialLockerResponse

Get information on an existing credential locker

getCustomEndpoint

abstract suspend fun getCustomEndpoint(input: GetCustomEndpointRequest = GetCustomEndpointRequest { }): GetCustomEndpointResponse

Returns the IoT managed integrations custom endpoint.

getDefaultEncryptionConfiguration

abstract suspend fun getDefaultEncryptionConfiguration(input: GetDefaultEncryptionConfigurationRequest = GetDefaultEncryptionConfigurationRequest { }): GetDefaultEncryptionConfigurationResponse

Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide.

getDestination

abstract suspend fun getDestination(input: GetDestinationRequest): GetDestinationResponse

Gets a destination by ID.

getDeviceDiscovery

abstract suspend fun getDeviceDiscovery(input: GetDeviceDiscoveryRequest): GetDeviceDiscoveryResponse

Get the current state of a device discovery.

getEventLogConfiguration

abstract suspend fun getEventLogConfiguration(input: GetEventLogConfigurationRequest): GetEventLogConfigurationResponse

Get an event log configuration.

getHubConfiguration

abstract suspend fun getHubConfiguration(input: GetHubConfigurationRequest = GetHubConfigurationRequest { }): GetHubConfigurationResponse

Get a hub configuration.

getManagedThing

abstract suspend fun getManagedThing(input: GetManagedThingRequest): GetManagedThingResponse

Get the attributes and capabilities associated with a managed thing.

getManagedThingCapabilities

abstract suspend fun getManagedThingCapabilities(input: GetManagedThingCapabilitiesRequest): GetManagedThingCapabilitiesResponse

Get the capabilities for a managed thing using the device ID.

getManagedThingConnectivityData

abstract suspend fun getManagedThingConnectivityData(input: GetManagedThingConnectivityDataRequest): GetManagedThingConnectivityDataResponse

Get the connectivity status of a managed thing.

getManagedThingMetaData

abstract suspend fun getManagedThingMetaData(input: GetManagedThingMetaDataRequest): GetManagedThingMetaDataResponse

Get the metadata information for a managed thing.

getManagedThingState

abstract suspend fun getManagedThingState(input: GetManagedThingStateRequest): GetManagedThingStateResponse

Returns the managed thing state for the given device Id.

getNotificationConfiguration

abstract suspend fun getNotificationConfiguration(input: GetNotificationConfigurationRequest): GetNotificationConfigurationResponse

Get a notification configuration.

getOtaTask

abstract suspend fun getOtaTask(input: GetOtaTaskRequest): GetOtaTaskResponse

Get the over-the-air (OTA) task.

getOtaTaskConfiguration

abstract suspend fun getOtaTaskConfiguration(input: GetOtaTaskConfigurationRequest): GetOtaTaskConfigurationResponse

Get a configuraiton for the over-the-air (OTA) task.

getProvisioningProfile

abstract suspend fun getProvisioningProfile(input: GetProvisioningProfileRequest): GetProvisioningProfileResponse

Get a provisioning profile by template name.

getRuntimeLogConfiguration

abstract suspend fun getRuntimeLogConfiguration(input: GetRuntimeLogConfigurationRequest): GetRuntimeLogConfigurationResponse

Get the runtime log configuration for a specific managed thing or for all managed things as a group.

getSchemaVersion

abstract suspend fun getSchemaVersion(input: GetSchemaVersionRequest): GetSchemaVersionResponse

Gets a schema version with the provided information.

listAccountAssociations

abstract suspend fun listAccountAssociations(input: ListAccountAssociationsRequest = ListAccountAssociationsRequest { }): ListAccountAssociationsResponse

Lists all account associations, with optional filtering by connector destination ID.

listCloudConnectors

abstract suspend fun listCloudConnectors(input: ListCloudConnectorsRequest = ListCloudConnectorsRequest { }): ListCloudConnectorsResponse

Returns a list of connectors based on permissions.

listConnectorDestinations

abstract suspend fun listConnectorDestinations(input: ListConnectorDestinationsRequest = ListConnectorDestinationsRequest { }): ListConnectorDestinationsResponse

Lists all connector destinations, with optional filtering by cloud connector ID.

listCredentialLockers

abstract suspend fun listCredentialLockers(input: ListCredentialLockersRequest = ListCredentialLockersRequest { }): ListCredentialLockersResponse

List information on an existing credential locker.

listDestinations

abstract suspend fun listDestinations(input: ListDestinationsRequest = ListDestinationsRequest { }): ListDestinationsResponse

List all destination names under one Amazon Web Services account.

listDeviceDiscoveries

abstract suspend fun listDeviceDiscoveries(input: ListDeviceDiscoveriesRequest = ListDeviceDiscoveriesRequest { }): ListDeviceDiscoveriesResponse

Lists all device discovery tasks, with optional filtering by type and status.

listDiscoveredDevices

abstract suspend fun listDiscoveredDevices(input: ListDiscoveredDevicesRequest): ListDiscoveredDevicesResponse

Lists all devices discovered during a specific device discovery task.

listEventLogConfigurations

abstract suspend fun listEventLogConfigurations(input: ListEventLogConfigurationsRequest = ListEventLogConfigurationsRequest { }): ListEventLogConfigurationsResponse

List all event log configurations for an account.

listManagedThingAccountAssociations

abstract suspend fun listManagedThingAccountAssociations(input: ListManagedThingAccountAssociationsRequest = ListManagedThingAccountAssociationsRequest { }): ListManagedThingAccountAssociationsResponse

Lists all account associations for a specific managed thing.

listManagedThings

abstract suspend fun listManagedThings(input: ListManagedThingsRequest = ListManagedThingsRequest { }): ListManagedThingsResponse

Listing all managed things with provision for filters.

listManagedThingSchemas

abstract suspend fun listManagedThingSchemas(input: ListManagedThingSchemasRequest): ListManagedThingSchemasResponse

List schemas associated with a managed thing.

listNotificationConfigurations

abstract suspend fun listNotificationConfigurations(input: ListNotificationConfigurationsRequest = ListNotificationConfigurationsRequest { }): ListNotificationConfigurationsResponse

List all notification configurations.

listOtaTaskConfigurations

abstract suspend fun listOtaTaskConfigurations(input: ListOtaTaskConfigurationsRequest = ListOtaTaskConfigurationsRequest { }): ListOtaTaskConfigurationsResponse

List all of the over-the-air (OTA) task configurations.

listOtaTaskExecutions

abstract suspend fun listOtaTaskExecutions(input: ListOtaTaskExecutionsRequest): ListOtaTaskExecutionsResponse

List all of the over-the-air (OTA) task executions.

listOtaTasks

abstract suspend fun listOtaTasks(input: ListOtaTasksRequest = ListOtaTasksRequest { }): ListOtaTasksResponse

List all of the over-the-air (OTA) tasks.

listProvisioningProfiles

abstract suspend fun listProvisioningProfiles(input: ListProvisioningProfilesRequest = ListProvisioningProfilesRequest { }): ListProvisioningProfilesResponse

List the provisioning profiles within the Amazon Web Services account.

listSchemaVersions

abstract suspend fun listSchemaVersions(input: ListSchemaVersionsRequest): ListSchemaVersionsResponse

Lists schema versions with the provided information.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

List tags for the specified resource.

putDefaultEncryptionConfiguration

abstract suspend fun putDefaultEncryptionConfiguration(input: PutDefaultEncryptionConfigurationRequest): PutDefaultEncryptionConfigurationResponse

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User Guide.

putHubConfiguration

abstract suspend fun putHubConfiguration(input: PutHubConfigurationRequest): PutHubConfigurationResponse

Update a hub configuration.

putRuntimeLogConfiguration

abstract suspend fun putRuntimeLogConfiguration(input: PutRuntimeLogConfigurationRequest): PutRuntimeLogConfigurationResponse

Set the runtime log configuration for a specific managed thing or for all managed things as a group.

registerAccountAssociation

abstract suspend fun registerAccountAssociation(input: RegisterAccountAssociationRequest): RegisterAccountAssociationResponse

Registers an account association with a managed thing, establishing a connection between a device and a third-party account.

registerCustomEndpoint

abstract suspend fun registerCustomEndpoint(input: RegisterCustomEndpointRequest = RegisterCustomEndpointRequest { }): RegisterCustomEndpointResponse

Customers can request IoT managed integrations to manage the server trust for them or bring their own external server trusts for the custom domain. Returns an IoT managed integrations endpoint.

resetRuntimeLogConfiguration

abstract suspend fun resetRuntimeLogConfiguration(input: ResetRuntimeLogConfigurationRequest): ResetRuntimeLogConfigurationResponse

Reset a runtime log configuration for a specific managed thing or for all managed things as a group.

sendConnectorEvent

abstract suspend fun sendConnectorEvent(input: SendConnectorEventRequest): SendConnectorEventResponse

Relays third-party device events for a connector such as a new device or a device state change event.

sendManagedThingCommand

abstract suspend fun sendManagedThingCommand(input: SendManagedThingCommandRequest): SendManagedThingCommandResponse

Send the command to the device represented by the managed thing.

startAccountAssociationRefresh

abstract suspend fun startAccountAssociationRefresh(input: StartAccountAssociationRefreshRequest): StartAccountAssociationRefreshResponse

Initiates a refresh of an existing account association to update its authorization and connection status.

startDeviceDiscovery

abstract suspend fun startDeviceDiscovery(input: StartDeviceDiscoveryRequest): StartDeviceDiscoveryResponse

This API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is passed as a message to the controller telling it to start the discovery.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Add tags for the specified resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Remove tags for the specified resource.

updateAccountAssociation

abstract suspend fun updateAccountAssociation(input: UpdateAccountAssociationRequest): UpdateAccountAssociationResponse

Updates the properties of an existing account association.

updateCloudConnector

abstract suspend fun updateCloudConnector(input: UpdateCloudConnectorRequest): UpdateCloudConnectorResponse

Update an existing cloud connector.

updateConnectorDestination

abstract suspend fun updateConnectorDestination(input: UpdateConnectorDestinationRequest): UpdateConnectorDestinationResponse

Updates the properties of an existing connector destination.

updateDestination

abstract suspend fun updateDestination(input: UpdateDestinationRequest): UpdateDestinationResponse

Update a destination specified by id.

updateEventLogConfiguration

abstract suspend fun updateEventLogConfiguration(input: UpdateEventLogConfigurationRequest): UpdateEventLogConfigurationResponse

Update an event log configuration by log configuration ID.

updateManagedThing

abstract suspend fun updateManagedThing(input: UpdateManagedThingRequest): UpdateManagedThingResponse

Update the attributes and capabilities associated with a managed thing.

updateNotificationConfiguration

abstract suspend fun updateNotificationConfiguration(input: UpdateNotificationConfigurationRequest): UpdateNotificationConfigurationResponse

Update a notification configuration.

updateOtaTask

abstract suspend fun updateOtaTask(input: UpdateOtaTaskRequest): UpdateOtaTaskResponse

Update an over-the-air (OTA) task.

Inherited functions

expect abstract fun close()

createAccountAssociation

inline suspend fun IotManagedIntegrationsClient.createAccountAssociation(crossinline block: CreateAccountAssociationRequest.Builder.() -> Unit): CreateAccountAssociationResponse

Creates a new account association via the destination id.

createCloudConnector

inline suspend fun IotManagedIntegrationsClient.createCloudConnector(crossinline block: CreateCloudConnectorRequest.Builder.() -> Unit): CreateCloudConnectorResponse

Creates a C2C (cloud-to-cloud) connector.

createConnectorDestination

inline suspend fun IotManagedIntegrationsClient.createConnectorDestination(crossinline block: CreateConnectorDestinationRequest.Builder.() -> Unit): CreateConnectorDestinationResponse

Create a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.

createCredentialLocker

inline suspend fun IotManagedIntegrationsClient.createCredentialLocker(crossinline block: CreateCredentialLockerRequest.Builder.() -> Unit): CreateCredentialLockerResponse

Create a product credential locker. This operation will trigger the creation of all the manufacturing resources including the Wi-Fi setup key pair and device certificate.

createDestination

inline suspend fun IotManagedIntegrationsClient.createDestination(crossinline block: CreateDestinationRequest.Builder.() -> Unit): CreateDestinationResponse

Create a destination. IoT managed integrations uses the destination to determine where to deliver notifications for a device.

createEventLogConfiguration

inline suspend fun IotManagedIntegrationsClient.createEventLogConfiguration(crossinline block: CreateEventLogConfigurationRequest.Builder.() -> Unit): CreateEventLogConfigurationResponse

Set the event log configuration for the account, resource type, or specific resource.

createManagedThing

inline suspend fun IotManagedIntegrationsClient.createManagedThing(crossinline block: CreateManagedThingRequest.Builder.() -> Unit): CreateManagedThingResponse

Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a protocol-specific format.

createNotificationConfiguration

inline suspend fun IotManagedIntegrationsClient.createNotificationConfiguration(crossinline block: CreateNotificationConfigurationRequest.Builder.() -> Unit): CreateNotificationConfigurationResponse

Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.

createOtaTask

inline suspend fun IotManagedIntegrationsClient.createOtaTask(crossinline block: CreateOtaTaskRequest.Builder.() -> Unit): CreateOtaTaskResponse

Create an over-the-air (OTA) task to update a device.

createOtaTaskConfiguration

inline suspend fun IotManagedIntegrationsClient.createOtaTaskConfiguration(crossinline block: CreateOtaTaskConfigurationRequest.Builder.() -> Unit): CreateOtaTaskConfigurationResponse

Create a configuraiton for the over-the-air (OTA) task.

createProvisioningProfile

inline suspend fun IotManagedIntegrationsClient.createProvisioningProfile(crossinline block: CreateProvisioningProfileRequest.Builder.() -> Unit): CreateProvisioningProfileResponse

deleteAccountAssociation

inline suspend fun IotManagedIntegrationsClient.deleteAccountAssociation(crossinline block: DeleteAccountAssociationRequest.Builder.() -> Unit): DeleteAccountAssociationResponse

Remove a third party account and related devices from an end user.

deleteCloudConnector

inline suspend fun IotManagedIntegrationsClient.deleteCloudConnector(crossinline block: DeleteCloudConnectorRequest.Builder.() -> Unit): DeleteCloudConnectorResponse

Delete a cloud connector.

deleteConnectorDestination

inline suspend fun IotManagedIntegrationsClient.deleteConnectorDestination(crossinline block: DeleteConnectorDestinationRequest.Builder.() -> Unit): DeleteConnectorDestinationResponse

Delete a connector destination for connecting a cloud-to-cloud (C2C) connector to the customer's Amazon Web Services account.

deleteCredentialLocker

inline suspend fun IotManagedIntegrationsClient.deleteCredentialLocker(crossinline block: DeleteCredentialLockerRequest.Builder.() -> Unit): DeleteCredentialLockerResponse

Delete a credential locker.

deleteDestination

inline suspend fun IotManagedIntegrationsClient.deleteDestination(crossinline block: DeleteDestinationRequest.Builder.() -> Unit): DeleteDestinationResponse

Deletes a customer-managed destination specified by id.

deleteEventLogConfiguration

inline suspend fun IotManagedIntegrationsClient.deleteEventLogConfiguration(crossinline block: DeleteEventLogConfigurationRequest.Builder.() -> Unit): DeleteEventLogConfigurationResponse

Delete an event log configuration.

deleteManagedThing

inline suspend fun IotManagedIntegrationsClient.deleteManagedThing(crossinline block: DeleteManagedThingRequest.Builder.() -> Unit): DeleteManagedThingResponse

Delete a managed thing. If a controller is deleted, all of the devices connected to it will have their status changed to PENDING. It is not possible to remove a cloud device.

deleteNotificationConfiguration

inline suspend fun IotManagedIntegrationsClient.deleteNotificationConfiguration(crossinline block: DeleteNotificationConfigurationRequest.Builder.() -> Unit): DeleteNotificationConfigurationResponse

Deletes a notification configuration.

deleteOtaTask

inline suspend fun IotManagedIntegrationsClient.deleteOtaTask(crossinline block: DeleteOtaTaskRequest.Builder.() -> Unit): DeleteOtaTaskResponse

Delete the over-the-air (OTA) task.

deleteOtaTaskConfiguration

inline suspend fun IotManagedIntegrationsClient.deleteOtaTaskConfiguration(crossinline block: DeleteOtaTaskConfigurationRequest.Builder.() -> Unit): DeleteOtaTaskConfigurationResponse

Delete the over-the-air (OTA) task configuration.

deleteProvisioningProfile

inline suspend fun IotManagedIntegrationsClient.deleteProvisioningProfile(crossinline block: DeleteProvisioningProfileRequest.Builder.() -> Unit): DeleteProvisioningProfileResponse

Delete a provisioning profile.

deregisterAccountAssociation

inline suspend fun IotManagedIntegrationsClient.deregisterAccountAssociation(crossinline block: DeregisterAccountAssociationRequest.Builder.() -> Unit): DeregisterAccountAssociationResponse

Deregisters an account association, removing the connection between a managed thing and a third-party account.

getAccountAssociation

inline suspend fun IotManagedIntegrationsClient.getAccountAssociation(crossinline block: GetAccountAssociationRequest.Builder.() -> Unit): GetAccountAssociationResponse

Get an account association for an Amazon Web Services account linked to a customer-managed destination.

getCloudConnector

inline suspend fun IotManagedIntegrationsClient.getCloudConnector(crossinline block: GetCloudConnectorRequest.Builder.() -> Unit): GetCloudConnectorResponse

Gets all the information about a connector for a connector developer.

getConnectorDestination

inline suspend fun IotManagedIntegrationsClient.getConnectorDestination(crossinline block: GetConnectorDestinationRequest.Builder.() -> Unit): GetConnectorDestinationResponse

Get a connector destination of a cloud-to-cloud (C2C) connector connecting to a customer's Amazon Web Services account.

getCredentialLocker

inline suspend fun IotManagedIntegrationsClient.getCredentialLocker(crossinline block: GetCredentialLockerRequest.Builder.() -> Unit): GetCredentialLockerResponse

Get information on an existing credential locker

getCustomEndpoint

inline suspend fun IotManagedIntegrationsClient.getCustomEndpoint(crossinline block: GetCustomEndpointRequest.Builder.() -> Unit): GetCustomEndpointResponse

Returns the IoT managed integrations custom endpoint.

getDefaultEncryptionConfiguration

inline suspend fun IotManagedIntegrationsClient.getDefaultEncryptionConfiguration(crossinline block: GetDefaultEncryptionConfigurationRequest.Builder.() -> Unit): GetDefaultEncryptionConfigurationResponse

getDestination

inline suspend fun IotManagedIntegrationsClient.getDestination(crossinline block: GetDestinationRequest.Builder.() -> Unit): GetDestinationResponse

Gets a destination by ID.

getDeviceDiscovery

inline suspend fun IotManagedIntegrationsClient.getDeviceDiscovery(crossinline block: GetDeviceDiscoveryRequest.Builder.() -> Unit): GetDeviceDiscoveryResponse

Get the current state of a device discovery.

getEventLogConfiguration

inline suspend fun IotManagedIntegrationsClient.getEventLogConfiguration(crossinline block: GetEventLogConfigurationRequest.Builder.() -> Unit): GetEventLogConfigurationResponse

Get an event log configuration.

getHubConfiguration

inline suspend fun IotManagedIntegrationsClient.getHubConfiguration(crossinline block: GetHubConfigurationRequest.Builder.() -> Unit): GetHubConfigurationResponse

Get a hub configuration.

getManagedThing

inline suspend fun IotManagedIntegrationsClient.getManagedThing(crossinline block: GetManagedThingRequest.Builder.() -> Unit): GetManagedThingResponse

Get the attributes and capabilities associated with a managed thing.

getManagedThingCapabilities

inline suspend fun IotManagedIntegrationsClient.getManagedThingCapabilities(crossinline block: GetManagedThingCapabilitiesRequest.Builder.() -> Unit): GetManagedThingCapabilitiesResponse

Get the capabilities for a managed thing using the device ID.

getManagedThingConnectivityData

inline suspend fun IotManagedIntegrationsClient.getManagedThingConnectivityData(crossinline block: GetManagedThingConnectivityDataRequest.Builder.() -> Unit): GetManagedThingConnectivityDataResponse

Get the connectivity status of a managed thing.

getManagedThingMetaData

inline suspend fun IotManagedIntegrationsClient.getManagedThingMetaData(crossinline block: GetManagedThingMetaDataRequest.Builder.() -> Unit): GetManagedThingMetaDataResponse

Get the metadata information for a managed thing.

getManagedThingState

inline suspend fun IotManagedIntegrationsClient.getManagedThingState(crossinline block: GetManagedThingStateRequest.Builder.() -> Unit): GetManagedThingStateResponse

Returns the managed thing state for the given device Id.

getNotificationConfiguration

inline suspend fun IotManagedIntegrationsClient.getNotificationConfiguration(crossinline block: GetNotificationConfigurationRequest.Builder.() -> Unit): GetNotificationConfigurationResponse

Get a notification configuration.

getOtaTask

inline suspend fun IotManagedIntegrationsClient.getOtaTask(crossinline block: GetOtaTaskRequest.Builder.() -> Unit): GetOtaTaskResponse

Get the over-the-air (OTA) task.

getOtaTaskConfiguration

inline suspend fun IotManagedIntegrationsClient.getOtaTaskConfiguration(crossinline block: GetOtaTaskConfigurationRequest.Builder.() -> Unit): GetOtaTaskConfigurationResponse

Get a configuraiton for the over-the-air (OTA) task.

getProvisioningProfile

inline suspend fun IotManagedIntegrationsClient.getProvisioningProfile(crossinline block: GetProvisioningProfileRequest.Builder.() -> Unit): GetProvisioningProfileResponse

Get a provisioning profile by template name.

getRuntimeLogConfiguration

inline suspend fun IotManagedIntegrationsClient.getRuntimeLogConfiguration(crossinline block: GetRuntimeLogConfigurationRequest.Builder.() -> Unit): GetRuntimeLogConfigurationResponse

Get the runtime log configuration for a specific managed thing or for all managed things as a group.

getSchemaVersion

inline suspend fun IotManagedIntegrationsClient.getSchemaVersion(crossinline block: GetSchemaVersionRequest.Builder.() -> Unit): GetSchemaVersionResponse

Gets a schema version with the provided information.

listAccountAssociations

inline suspend fun IotManagedIntegrationsClient.listAccountAssociations(crossinline block: ListAccountAssociationsRequest.Builder.() -> Unit): ListAccountAssociationsResponse

Lists all account associations, with optional filtering by connector destination ID.

listAccountAssociationsPaginated

fun IotManagedIntegrationsClient.listAccountAssociationsPaginated(initialRequest: ListAccountAssociationsRequest = ListAccountAssociationsRequest { }): Flow<ListAccountAssociationsResponse>

fun IotManagedIntegrationsClient.listAccountAssociationsPaginated(block: ListAccountAssociationsRequest.Builder.() -> Unit): Flow<ListAccountAssociationsResponse>

Paginate over ListAccountAssociationsResponse results.

listCloudConnectors

inline suspend fun IotManagedIntegrationsClient.listCloudConnectors(crossinline block: ListCloudConnectorsRequest.Builder.() -> Unit): ListCloudConnectorsResponse

Returns a list of connectors based on permissions.

listCloudConnectorsPaginated

fun IotManagedIntegrationsClient.listCloudConnectorsPaginated(initialRequest: ListCloudConnectorsRequest = ListCloudConnectorsRequest { }): Flow<ListCloudConnectorsResponse>

fun IotManagedIntegrationsClient.listCloudConnectorsPaginated(block: ListCloudConnectorsRequest.Builder.() -> Unit): Flow<ListCloudConnectorsResponse>

Paginate over ListCloudConnectorsResponse results.

listConnectorDestinations

inline suspend fun IotManagedIntegrationsClient.listConnectorDestinations(crossinline block: ListConnectorDestinationsRequest.Builder.() -> Unit): ListConnectorDestinationsResponse

Lists all connector destinations, with optional filtering by cloud connector ID.

listConnectorDestinationsPaginated

fun IotManagedIntegrationsClient.listConnectorDestinationsPaginated(initialRequest: ListConnectorDestinationsRequest = ListConnectorDestinationsRequest { }): Flow<ListConnectorDestinationsResponse>

fun IotManagedIntegrationsClient.listConnectorDestinationsPaginated(block: ListConnectorDestinationsRequest.Builder.() -> Unit): Flow<ListConnectorDestinationsResponse>

Paginate over ListConnectorDestinationsResponse results.

listCredentialLockers

inline suspend fun IotManagedIntegrationsClient.listCredentialLockers(crossinline block: ListCredentialLockersRequest.Builder.() -> Unit): ListCredentialLockersResponse

List information on an existing credential locker.

listCredentialLockersPaginated

fun IotManagedIntegrationsClient.listCredentialLockersPaginated(initialRequest: ListCredentialLockersRequest = ListCredentialLockersRequest { }): Flow<ListCredentialLockersResponse>

fun IotManagedIntegrationsClient.listCredentialLockersPaginated(block: ListCredentialLockersRequest.Builder.() -> Unit): Flow<ListCredentialLockersResponse>

Paginate over ListCredentialLockersResponse results.

listDestinations

inline suspend fun IotManagedIntegrationsClient.listDestinations(crossinline block: ListDestinationsRequest.Builder.() -> Unit): ListDestinationsResponse

List all destination names under one Amazon Web Services account.

listDestinationsPaginated

fun IotManagedIntegrationsClient.listDestinationsPaginated(initialRequest: ListDestinationsRequest = ListDestinationsRequest { }): Flow<ListDestinationsResponse>

fun IotManagedIntegrationsClient.listDestinationsPaginated(block: ListDestinationsRequest.Builder.() -> Unit): Flow<ListDestinationsResponse>

Paginate over ListDestinationsResponse results.

listDeviceDiscoveries

inline suspend fun IotManagedIntegrationsClient.listDeviceDiscoveries(crossinline block: ListDeviceDiscoveriesRequest.Builder.() -> Unit): ListDeviceDiscoveriesResponse

Lists all device discovery tasks, with optional filtering by type and status.

listDeviceDiscoveriesPaginated

fun IotManagedIntegrationsClient.listDeviceDiscoveriesPaginated(initialRequest: ListDeviceDiscoveriesRequest = ListDeviceDiscoveriesRequest { }): Flow<ListDeviceDiscoveriesResponse>

fun IotManagedIntegrationsClient.listDeviceDiscoveriesPaginated(block: ListDeviceDiscoveriesRequest.Builder.() -> Unit): Flow<ListDeviceDiscoveriesResponse>

Paginate over ListDeviceDiscoveriesResponse results.

listDiscoveredDevices

inline suspend fun IotManagedIntegrationsClient.listDiscoveredDevices(crossinline block: ListDiscoveredDevicesRequest.Builder.() -> Unit): ListDiscoveredDevicesResponse

Lists all devices discovered during a specific device discovery task.

listDiscoveredDevicesPaginated

fun IotManagedIntegrationsClient.listDiscoveredDevicesPaginated(initialRequest: ListDiscoveredDevicesRequest): Flow<ListDiscoveredDevicesResponse>

fun IotManagedIntegrationsClient.listDiscoveredDevicesPaginated(block: ListDiscoveredDevicesRequest.Builder.() -> Unit): Flow<ListDiscoveredDevicesResponse>

Paginate over ListDiscoveredDevicesResponse results.

listEventLogConfigurations

inline suspend fun IotManagedIntegrationsClient.listEventLogConfigurations(crossinline block: ListEventLogConfigurationsRequest.Builder.() -> Unit): ListEventLogConfigurationsResponse

List all event log configurations for an account.

listEventLogConfigurationsPaginated

fun IotManagedIntegrationsClient.listEventLogConfigurationsPaginated(initialRequest: ListEventLogConfigurationsRequest = ListEventLogConfigurationsRequest { }): Flow<ListEventLogConfigurationsResponse>

fun IotManagedIntegrationsClient.listEventLogConfigurationsPaginated(block: ListEventLogConfigurationsRequest.Builder.() -> Unit): Flow<ListEventLogConfigurationsResponse>

Paginate over ListEventLogConfigurationsResponse results.

listManagedThingAccountAssociations

inline suspend fun IotManagedIntegrationsClient.listManagedThingAccountAssociations(crossinline block: ListManagedThingAccountAssociationsRequest.Builder.() -> Unit): ListManagedThingAccountAssociationsResponse

Lists all account associations for a specific managed thing.

listManagedThingAccountAssociationsPaginated

fun IotManagedIntegrationsClient.listManagedThingAccountAssociationsPaginated(initialRequest: ListManagedThingAccountAssociationsRequest = ListManagedThingAccountAssociationsRequest { }): Flow<ListManagedThingAccountAssociationsResponse>

fun IotManagedIntegrationsClient.listManagedThingAccountAssociationsPaginated(block: ListManagedThingAccountAssociationsRequest.Builder.() -> Unit): Flow<ListManagedThingAccountAssociationsResponse>

Paginate over ListManagedThingAccountAssociationsResponse results.

listManagedThings

inline suspend fun IotManagedIntegrationsClient.listManagedThings(crossinline block: ListManagedThingsRequest.Builder.() -> Unit): ListManagedThingsResponse

Listing all managed things with provision for filters.

listManagedThingSchemas

inline suspend fun IotManagedIntegrationsClient.listManagedThingSchemas(crossinline block: ListManagedThingSchemasRequest.Builder.() -> Unit): ListManagedThingSchemasResponse

List schemas associated with a managed thing.

listManagedThingSchemasPaginated

fun IotManagedIntegrationsClient.listManagedThingSchemasPaginated(initialRequest: ListManagedThingSchemasRequest): Flow<ListManagedThingSchemasResponse>

fun IotManagedIntegrationsClient.listManagedThingSchemasPaginated(block: ListManagedThingSchemasRequest.Builder.() -> Unit): Flow<ListManagedThingSchemasResponse>

Paginate over ListManagedThingSchemasResponse results.

listManagedThingsPaginated

fun IotManagedIntegrationsClient.listManagedThingsPaginated(initialRequest: ListManagedThingsRequest = ListManagedThingsRequest { }): Flow<ListManagedThingsResponse>

fun IotManagedIntegrationsClient.listManagedThingsPaginated(block: ListManagedThingsRequest.Builder.() -> Unit): Flow<ListManagedThingsResponse>

Paginate over ListManagedThingsResponse results.

listNotificationConfigurations

inline suspend fun IotManagedIntegrationsClient.listNotificationConfigurations(crossinline block: ListNotificationConfigurationsRequest.Builder.() -> Unit): ListNotificationConfigurationsResponse

List all notification configurations.

listNotificationConfigurationsPaginated

fun IotManagedIntegrationsClient.listNotificationConfigurationsPaginated(initialRequest: ListNotificationConfigurationsRequest = ListNotificationConfigurationsRequest { }): Flow<ListNotificationConfigurationsResponse>

fun IotManagedIntegrationsClient.listNotificationConfigurationsPaginated(block: ListNotificationConfigurationsRequest.Builder.() -> Unit): Flow<ListNotificationConfigurationsResponse>

Paginate over ListNotificationConfigurationsResponse results.

listOtaTaskConfigurations

inline suspend fun IotManagedIntegrationsClient.listOtaTaskConfigurations(crossinline block: ListOtaTaskConfigurationsRequest.Builder.() -> Unit): ListOtaTaskConfigurationsResponse

List all of the over-the-air (OTA) task configurations.

listOtaTaskConfigurationsPaginated

fun IotManagedIntegrationsClient.listOtaTaskConfigurationsPaginated(initialRequest: ListOtaTaskConfigurationsRequest = ListOtaTaskConfigurationsRequest { }): Flow<ListOtaTaskConfigurationsResponse>

fun IotManagedIntegrationsClient.listOtaTaskConfigurationsPaginated(block: ListOtaTaskConfigurationsRequest.Builder.() -> Unit): Flow<ListOtaTaskConfigurationsResponse>

Paginate over ListOtaTaskConfigurationsResponse results.

listOtaTaskExecutions

inline suspend fun IotManagedIntegrationsClient.listOtaTaskExecutions(crossinline block: ListOtaTaskExecutionsRequest.Builder.() -> Unit): ListOtaTaskExecutionsResponse

List all of the over-the-air (OTA) task executions.

listOtaTaskExecutionsPaginated

fun IotManagedIntegrationsClient.listOtaTaskExecutionsPaginated(initialRequest: ListOtaTaskExecutionsRequest): Flow<ListOtaTaskExecutionsResponse>

fun IotManagedIntegrationsClient.listOtaTaskExecutionsPaginated(block: ListOtaTaskExecutionsRequest.Builder.() -> Unit): Flow<ListOtaTaskExecutionsResponse>

Paginate over ListOtaTaskExecutionsResponse results.

listOtaTasks

inline suspend fun IotManagedIntegrationsClient.listOtaTasks(crossinline block: ListOtaTasksRequest.Builder.() -> Unit): ListOtaTasksResponse

List all of the over-the-air (OTA) tasks.

listOtaTasksPaginated

fun IotManagedIntegrationsClient.listOtaTasksPaginated(initialRequest: ListOtaTasksRequest = ListOtaTasksRequest { }): Flow<ListOtaTasksResponse>

fun IotManagedIntegrationsClient.listOtaTasksPaginated(block: ListOtaTasksRequest.Builder.() -> Unit): Flow<ListOtaTasksResponse>

Paginate over ListOtaTasksResponse results.

listProvisioningProfiles

inline suspend fun IotManagedIntegrationsClient.listProvisioningProfiles(crossinline block: ListProvisioningProfilesRequest.Builder.() -> Unit): ListProvisioningProfilesResponse

List the provisioning profiles within the Amazon Web Services account.

listProvisioningProfilesPaginated

fun IotManagedIntegrationsClient.listProvisioningProfilesPaginated(initialRequest: ListProvisioningProfilesRequest = ListProvisioningProfilesRequest { }): Flow<ListProvisioningProfilesResponse>

fun IotManagedIntegrationsClient.listProvisioningProfilesPaginated(block: ListProvisioningProfilesRequest.Builder.() -> Unit): Flow<ListProvisioningProfilesResponse>

Paginate over ListProvisioningProfilesResponse results.

listSchemaVersions

inline suspend fun IotManagedIntegrationsClient.listSchemaVersions(crossinline block: ListSchemaVersionsRequest.Builder.() -> Unit): ListSchemaVersionsResponse

Lists schema versions with the provided information.

listSchemaVersionsPaginated

fun IotManagedIntegrationsClient.listSchemaVersionsPaginated(initialRequest: ListSchemaVersionsRequest): Flow<ListSchemaVersionsResponse>

fun IotManagedIntegrationsClient.listSchemaVersionsPaginated(block: ListSchemaVersionsRequest.Builder.() -> Unit): Flow<ListSchemaVersionsResponse>

Paginate over ListSchemaVersionsResponse results.

listTagsForResource

inline suspend fun IotManagedIntegrationsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List tags for the specified resource.

putDefaultEncryptionConfiguration

inline suspend fun IotManagedIntegrationsClient.putDefaultEncryptionConfiguration(crossinline block: PutDefaultEncryptionConfigurationRequest.Builder.() -> Unit): PutDefaultEncryptionConfigurationResponse

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User Guide.

putHubConfiguration

inline suspend fun IotManagedIntegrationsClient.putHubConfiguration(crossinline block: PutHubConfigurationRequest.Builder.() -> Unit): PutHubConfigurationResponse

Update a hub configuration.

putRuntimeLogConfiguration

inline suspend fun IotManagedIntegrationsClient.putRuntimeLogConfiguration(crossinline block: PutRuntimeLogConfigurationRequest.Builder.() -> Unit): PutRuntimeLogConfigurationResponse

Set the runtime log configuration for a specific managed thing or for all managed things as a group.

registerAccountAssociation

inline suspend fun IotManagedIntegrationsClient.registerAccountAssociation(crossinline block: RegisterAccountAssociationRequest.Builder.() -> Unit): RegisterAccountAssociationResponse

Registers an account association with a managed thing, establishing a connection between a device and a third-party account.

registerCustomEndpoint

inline suspend fun IotManagedIntegrationsClient.registerCustomEndpoint(crossinline block: RegisterCustomEndpointRequest.Builder.() -> Unit): RegisterCustomEndpointResponse

Customers can request IoT managed integrations to manage the server trust for them or bring their own external server trusts for the custom domain. Returns an IoT managed integrations endpoint.

resetRuntimeLogConfiguration

inline suspend fun IotManagedIntegrationsClient.resetRuntimeLogConfiguration(crossinline block: ResetRuntimeLogConfigurationRequest.Builder.() -> Unit): ResetRuntimeLogConfigurationResponse

Reset a runtime log configuration for a specific managed thing or for all managed things as a group.

sendConnectorEvent

inline suspend fun IotManagedIntegrationsClient.sendConnectorEvent(crossinline block: SendConnectorEventRequest.Builder.() -> Unit): SendConnectorEventResponse

Relays third-party device events for a connector such as a new device or a device state change event.

sendManagedThingCommand

inline suspend fun IotManagedIntegrationsClient.sendManagedThingCommand(crossinline block: SendManagedThingCommandRequest.Builder.() -> Unit): SendManagedThingCommandResponse

Send the command to the device represented by the managed thing.

startAccountAssociationRefresh

inline suspend fun IotManagedIntegrationsClient.startAccountAssociationRefresh(crossinline block: StartAccountAssociationRefreshRequest.Builder.() -> Unit): StartAccountAssociationRefreshResponse

Initiates a refresh of an existing account association to update its authorization and connection status.

startDeviceDiscovery

inline suspend fun IotManagedIntegrationsClient.startDeviceDiscovery(crossinline block: StartDeviceDiscoveryRequest.Builder.() -> Unit): StartDeviceDiscoveryResponse

tagResource

inline suspend fun IotManagedIntegrationsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Add tags for the specified resource.

untagResource

inline suspend fun IotManagedIntegrationsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Remove tags for the specified resource.

updateAccountAssociation

inline suspend fun IotManagedIntegrationsClient.updateAccountAssociation(crossinline block: UpdateAccountAssociationRequest.Builder.() -> Unit): UpdateAccountAssociationResponse

Updates the properties of an existing account association.

updateCloudConnector

inline suspend fun IotManagedIntegrationsClient.updateCloudConnector(crossinline block: UpdateCloudConnectorRequest.Builder.() -> Unit): UpdateCloudConnectorResponse

Update an existing cloud connector.

updateConnectorDestination

inline suspend fun IotManagedIntegrationsClient.updateConnectorDestination(crossinline block: UpdateConnectorDestinationRequest.Builder.() -> Unit): UpdateConnectorDestinationResponse

Updates the properties of an existing connector destination.

updateDestination

inline suspend fun IotManagedIntegrationsClient.updateDestination(crossinline block: UpdateDestinationRequest.Builder.() -> Unit): UpdateDestinationResponse

Update a destination specified by id.

updateEventLogConfiguration

inline suspend fun IotManagedIntegrationsClient.updateEventLogConfiguration(crossinline block: UpdateEventLogConfigurationRequest.Builder.() -> Unit): UpdateEventLogConfigurationResponse

Update an event log configuration by log configuration ID.

updateManagedThing

inline suspend fun IotManagedIntegrationsClient.updateManagedThing(crossinline block: UpdateManagedThingRequest.Builder.() -> Unit): UpdateManagedThingResponse

Update the attributes and capabilities associated with a managed thing.

updateNotificationConfiguration

inline suspend fun IotManagedIntegrationsClient.updateNotificationConfiguration(crossinline block: UpdateNotificationConfigurationRequest.Builder.() -> Unit): UpdateNotificationConfigurationResponse

Update a notification configuration.

updateOtaTask

inline suspend fun IotManagedIntegrationsClient.updateOtaTask(crossinline block: UpdateOtaTaskRequest.Builder.() -> Unit): UpdateOtaTaskResponse

Update an over-the-air (OTA) task.

withConfig

fun IotManagedIntegrationsClient.withConfig(block: IotManagedIntegrationsClient.Config.Builder.() -> Unit): IotManagedIntegrationsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.