AWSIoT1ClickProjectsClient (AWS Java SDK for AWS IoT 1-Click Projects 1.11.415 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.iot1clickprojects.AWSIoT1ClickProjectsClient

All Implemented Interfaces:

AWSIoT1ClickProjects

Direct Known Subclasses:

AWSIoT1ClickProjectsAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIoT1ClickProjectsClient
extends AmazonWebServiceClient
implements AWSIoT1ClickProjects
```
Client for accessing AWS IoT 1-Click Projects. All service calls made using this client are blocking, and will not return until the service call completes.

The AWS IoT 1-Click Project API Reference

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.iot1clickprojects.AWSIoT1ClickProjects
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateDeviceWithPlacementResult`	`associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest request)` Associates a physical device with a placement.
`static AWSIoT1ClickProjectsClientBuilder`	`builder()`
`CreatePlacementResult`	`createPlacement(CreatePlacementRequest request)` Creates an empty placement.
`CreateProjectResult`	`createProject(CreateProjectRequest request)` Creates an empty project with a placement template.
`DeletePlacementResult`	`deletePlacement(DeletePlacementRequest request)` Deletes a placement.
`DeleteProjectResult`	`deleteProject(DeleteProjectRequest request)` Deletes a project.
`DescribePlacementResult`	`describePlacement(DescribePlacementRequest request)` Describes a placement in a project.
`DescribeProjectResult`	`describeProject(DescribeProjectRequest request)` Returns an object describing a project.
`DisassociateDeviceFromPlacementResult`	`disassociateDeviceFromPlacement(DisassociateDeviceFromPlacementRequest request)` Removes a physical device from a placement.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetDevicesInPlacementResult`	`getDevicesInPlacement(GetDevicesInPlacementRequest request)` Returns an object enumerating the devices in a placement.
`ListPlacementsResult`	`listPlacements(ListPlacementsRequest request)` Lists the placement(s) of a project.
`ListProjectsResult`	`listProjects(ListProjectsRequest request)` Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
`UpdatePlacementResult`	`updatePlacement(UpdatePlacementRequest request)` Updates a placement with the given attributes.
`UpdateProjectResult`	`updateProject(UpdateProjectRequest request)` Updates a project associated with your AWS account and region.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.iot1clickprojects.AWSIoT1ClickProjects
shutdown

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AWSIoT1ClickProjectsClientBuilder builder()
```
  - associateDeviceWithPlacement
```
public AssociateDeviceWithPlacementResult associateDeviceWithPlacement(AssociateDeviceWithPlacementRequest request)
```
    Associates a physical device with a placement.
    
    Specified by:
    
    associateDeviceWithPlacement in interface AWSIoT1ClickProjects
    
    Parameters:
    
    associateDeviceWithPlacementRequest -
    
    Returns:
    
    Result of the AssociateDeviceWithPlacement operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceConflictException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - createPlacement
```
public CreatePlacementResult createPlacement(CreatePlacementRequest request)
```
    Creates an empty placement.
    
    Specified by:
    
    createPlacement in interface AWSIoT1ClickProjects
    
    Parameters:
    
    createPlacementRequest -
    
    Returns:
    
    Result of the CreatePlacement operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceConflictException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - createProject
```
public CreateProjectResult createProject(CreateProjectRequest request)
```
    Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.
    
    Specified by:
    
    createProject in interface AWSIoT1ClickProjects
    
    Parameters:
    
    createProjectRequest -
    
    Returns:
    
    Result of the CreateProject operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceConflictException
    
    See Also:
    
    AWS API Documentation
  - deletePlacement
```
public DeletePlacementResult deletePlacement(DeletePlacementRequest request)
```
    Deletes a placement. To delete a placement, it must not have any devices associated with it.
    
    When you delete a placement, all associated data becomes irretrievable.
    
    Specified by:
    
    deletePlacement in interface AWSIoT1ClickProjects
    
    Parameters:
    
    deletePlacementRequest -
    
    Returns:
    
    Result of the DeletePlacement operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceNotFoundException
    
    TooManyRequestsException
    
    See Also:
    
    AWS API Documentation
  - deleteProject
```
public DeleteProjectResult deleteProject(DeleteProjectRequest request)
```
    Deletes a project. To delete a project, it must not have any placements associated with it.
    
    When you delete a project, all associated data becomes irretrievable.
    
    Specified by:
    
    deleteProject in interface AWSIoT1ClickProjects
    
    Parameters:
    
    deleteProjectRequest -
    
    Returns:
    
    Result of the DeleteProject operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceNotFoundException
    
    TooManyRequestsException
    
    See Also:
    
    AWS API Documentation
  - describePlacement
```
public DescribePlacementResult describePlacement(DescribePlacementRequest request)
```
    Describes a placement in a project.
    
    Specified by:
    
    describePlacement in interface AWSIoT1ClickProjects
    
    Parameters:
    
    describePlacementRequest -
    
    Returns:
    
    Result of the DescribePlacement operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - describeProject
```
public DescribeProjectResult describeProject(DescribeProjectRequest request)
```
    Returns an object describing a project.
    
    Specified by:
    
    describeProject in interface AWSIoT1ClickProjects
    
    Parameters:
    
    describeProjectRequest -
    
    Returns:
    
    Result of the DescribeProject operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - disassociateDeviceFromPlacement
```
public DisassociateDeviceFromPlacementResult disassociateDeviceFromPlacement(DisassociateDeviceFromPlacementRequest request)
```
    Removes a physical device from a placement.
    
    Specified by:
    
    disassociateDeviceFromPlacement in interface AWSIoT1ClickProjects
    
    Parameters:
    
    disassociateDeviceFromPlacementRequest -
    
    Returns:
    
    Result of the DisassociateDeviceFromPlacement operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceNotFoundException
    
    TooManyRequestsException
    
    See Also:
    
    AWS API Documentation
  - getDevicesInPlacement
```
public GetDevicesInPlacementResult getDevicesInPlacement(GetDevicesInPlacementRequest request)
```
    Returns an object enumerating the devices in a placement.
    
    Specified by:
    
    getDevicesInPlacement in interface AWSIoT1ClickProjects
    
    Parameters:
    
    getDevicesInPlacementRequest -
    
    Returns:
    
    Result of the GetDevicesInPlacement operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - listPlacements
```
public ListPlacementsResult listPlacements(ListPlacementsRequest request)
```
    Lists the placement(s) of a project.
    
    Specified by:
    
    listPlacements in interface AWSIoT1ClickProjects
    
    Parameters:
    
    listPlacementsRequest -
    
    Returns:
    
    Result of the ListPlacements operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - listProjects
```
public ListProjectsResult listProjects(ListProjectsRequest request)
```
    Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
    
    Specified by:
    
    listProjects in interface AWSIoT1ClickProjects
    
    Parameters:
    
    listProjectsRequest -
    
    Returns:
    
    Result of the ListProjects operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    See Also:
    
    AWS API Documentation
  - updatePlacement
```
public UpdatePlacementResult updatePlacement(UpdatePlacementRequest request)
```
    Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
    
    Specified by:
    
    updatePlacement in interface AWSIoT1ClickProjects
    
    Parameters:
    
    updatePlacementRequest -
    
    Returns:
    
    Result of the UpdatePlacement operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceNotFoundException
    
    TooManyRequestsException
    
    See Also:
    
    AWS API Documentation
  - updateProject
```
public UpdateProjectResult updateProject(UpdateProjectRequest request)
```
    Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., "").
    
    Specified by:
    
    updateProject in interface AWSIoT1ClickProjects
    
    Parameters:
    
    updateProjectRequest -
    
    Returns:
    
    Result of the UpdateProject operation returned by the service.
    
    Throws:
    
    InternalFailureException
    
    InvalidRequestException
    
    ResourceNotFoundException
    
    TooManyRequestsException
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSIoT1ClickProjects
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AWSIoT1ClickProjectsClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.iot1clickprojects.AWSIoT1ClickProjects

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.iot1clickprojects.AWSIoT1ClickProjects

Field Detail

configFactory

Method Detail

builder

associateDeviceWithPlacement

createPlacement

createProject

deletePlacement

deleteProject

describePlacement

describeProject

disassociateDeviceFromPlacement

getDevicesInPlacement

listPlacements

listProjects

updatePlacement

updateProject

getCachedResponseMetadata