AWS IoT Wireless
    AWS IoT Wireless
    • /partner-accounts
      POST
    • /accept-certificate-transfer/{certificateId}
      PATCH
    • /partner-accounts
      GET
    • /billing-groups/addThingToBillingGroup
      PUT
    • /wireless-devices/{Id}/thing
      PUT
    • /thing-groups/addThingToThingGroup
      PUT
    • /wireless-devices/{Id}/thing
      DELETE
    • /jobs/{jobId}/targets
      POST
    • /wireless-gateways/{Id}/certificate
      PUT
    • /target-policies/{policyName}
      PUT
    • /wireless-gateways/{Id}/certificate
      DELETE
    • /target-policies/{policyName}
      POST
    • /wireless-gateways/{Id}/certificate
      GET
    • /principal-policies/{policyName}
      PUT
    • /wireless-gateways/{Id}/thing
      PUT
    • /principal-policies/{policyName}
      DELETE
    • /wireless-gateways/{Id}/thing
      DELETE
    • /security-profiles/{securityProfileName}/targets
      PUT
    • /destinations
      POST
    • /security-profiles/{securityProfileName}/targets
      DELETE
    • /destinations
      GET
    • /things/{thingName}/principals
      PUT
    • /device-profiles
      POST
    • /things/{thingName}/principals
      DELETE
    • /device-profiles
      GET
    • /audit/mitigationactions/tasks/{taskId}/cancel
      PUT
    • /service-profiles
      POST
    • /audit/tasks/{taskId}/cancel
      PUT
    • /service-profiles
      GET
    • /cancel-certificate-transfer/{certificateId}
      PATCH
    • /wireless-devices
      POST
    • /detect/mitigationactions/tasks/{taskId}/cancel
      PUT
    • /wireless-devices
      GET
    • /jobs/{jobId}/cancel
      PUT
    • /wireless-gateways
      POST
    • /things/{thingName}/jobs/{jobId}/cancel
      PUT
    • /wireless-gateways
      GET
    • /default-authorizer
      DELETE
    • /wireless-gateways/{Id}/tasks
      POST
    • /default-authorizer
      GET
    • /wireless-gateways/{Id}/tasks
      DELETE
    • /default-authorizer
      POST
    • /wireless-gateways/{Id}/tasks
      GET
    • /confirmdestination/{confirmationToken}
      GET
    • /wireless-gateway-task-definitions
      POST
    • /audit/suppressions/create
      POST
    • /wireless-gateway-task-definitions
      GET
    • /authorizer/{authorizerName}
      POST
    • /destinations/{Name}
      DELETE
    • /authorizer/{authorizerName}
      DELETE
    • /destinations/{Name}
      GET
    • /authorizer/{authorizerName}
      GET
    • /destinations/{Name}
      PATCH
    • /authorizer/{authorizerName}
      PUT
    • /device-profiles/{Id}
      DELETE
    • /billing-groups/{billingGroupName}
      POST
    • /device-profiles/{Id}
      GET
    • /billing-groups/{billingGroupName}
      DELETE
    • /service-profiles/{Id}
      DELETE
    • /billing-groups/{billingGroupName}
      GET
    • /service-profiles/{Id}
      GET
    • /billing-groups/{billingGroupName}
      PATCH
    • /wireless-devices/{Id}
      DELETE
    • /certificates
      POST
    • /wireless-devices/{Id}
      PATCH
    • /certificates
      GET
    • /wireless-gateways/{Id}
      DELETE
    • /custom-metric/{metricName}
      POST
    • /wireless-gateways/{Id}
      PATCH
    • /custom-metric/{metricName}
      DELETE
    • /wireless-gateway-task-definitions/{Id}
      DELETE
    • /custom-metric/{metricName}
      GET
    • /wireless-gateway-task-definitions/{Id}
      GET
    • /custom-metric/{metricName}
      PATCH
    • /partner-accounts/{PartnerAccountId}
      DELETE
    • /dimensions/{name}
      POST
    • /partner-accounts/{PartnerAccountId}
      GET
    • /dimensions/{name}
      DELETE
    • /partner-accounts/{PartnerAccountId}
      PATCH
    • /dimensions/{name}
      GET
    • /log-levels
      GET
    • /dimensions/{name}
      PATCH
    • /log-levels
      DELETE
    • /domainConfigurations/{domainConfigurationName}
      POST
    • /log-levels
      POST
    • /domainConfigurations/{domainConfigurationName}
      DELETE
    • /log-levels/{ResourceIdentifier}
      GET
    • /domainConfigurations/{domainConfigurationName}
      GET
    • /log-levels/{ResourceIdentifier}
      PUT
    • /domainConfigurations/{domainConfigurationName}
      PUT
    • /log-levels/{ResourceIdentifier}
      DELETE
    • /dynamic-thing-groups/{thingGroupName}
      POST
    • /service-endpoint
      GET
    • /dynamic-thing-groups/{thingGroupName}
      DELETE
    • /wireless-devices/{Identifier}
      GET
    • /dynamic-thing-groups/{thingGroupName}
      PATCH
    • /wireless-devices/{Id}/statistics
      GET
    • /fleet-metric/{metricName}
      PUT
    • /wireless-gateways/{Identifier}
      GET
    • /fleet-metric/{metricName}
      DELETE
    • /wireless-gateways/{Id}/firmware-information
      GET
    • /fleet-metric/{metricName}
      GET
    • /wireless-gateways/{Id}/statistics
      GET
    • /fleet-metric/{metricName}
      PATCH
    • /tags
      GET
    • /jobs/{jobId}
      PUT
    • /tags
      POST
    • /jobs/{jobId}
      DELETE
    • /wireless-devices/{Id}/data
      POST
    • /jobs/{jobId}
      GET
    • /wireless-devices/{Id}/test
      POST
    • /jobs/{jobId}
      PATCH
    • /tags
      DELETE
    • /job-templates/{jobTemplateId}
      PUT
    • /job-templates/{jobTemplateId}
      DELETE
    • /job-templates/{jobTemplateId}
      GET
    • /keys-and-certificate
      POST
    • /mitigationactions/actions/{actionName}
      POST
    • /mitigationactions/actions/{actionName}
      DELETE
    • /mitigationactions/actions/{actionName}
      GET
    • /mitigationactions/actions/{actionName}
      PATCH
    • /otaUpdates/{otaUpdateId}
      POST
    • /otaUpdates/{otaUpdateId}
      DELETE
    • /otaUpdates/{otaUpdateId}
      GET
    • /policies/{policyName}
      POST
    • /policies/{policyName}
      DELETE
    • /policies/{policyName}
      GET
    • /policies/{policyName}/version
      POST
    • /policies/{policyName}/version
      GET
    • /provisioning-templates/{templateName}/provisioning-claim
      POST
    • /provisioning-templates
      POST
    • /provisioning-templates
      GET
    • /provisioning-templates/{templateName}/versions
      POST
    • /provisioning-templates/{templateName}/versions
      GET
    • /role-aliases/{roleAlias}
      POST
    • /role-aliases/{roleAlias}
      DELETE
    • /role-aliases/{roleAlias}
      GET
    • /role-aliases/{roleAlias}
      PUT
    • /audit/scheduledaudits/{scheduledAuditName}
      POST
    • /audit/scheduledaudits/{scheduledAuditName}
      DELETE
    • /audit/scheduledaudits/{scheduledAuditName}
      GET
    • /audit/scheduledaudits/{scheduledAuditName}
      PATCH
    • /security-profiles/{securityProfileName}
      POST
    • /security-profiles/{securityProfileName}
      DELETE
    • /security-profiles/{securityProfileName}
      GET
    • /security-profiles/{securityProfileName}
      PATCH
    • /streams/{streamId}
      POST
    • /streams/{streamId}
      DELETE
    • /streams/{streamId}
      GET
    • /streams/{streamId}
      PUT
    • /things/{thingName}
      POST
    • /things/{thingName}
      DELETE
    • /things/{thingName}
      GET
    • /things/{thingName}
      PATCH
    • /thing-groups/{thingGroupName}
      POST
    • /thing-groups/{thingGroupName}
      DELETE
    • /thing-groups/{thingGroupName}
      GET
    • /thing-groups/{thingGroupName}
      PATCH
    • /thing-types/{thingTypeName}
      POST
    • /thing-types/{thingTypeName}
      DELETE
    • /thing-types/{thingTypeName}
      GET
    • /rules/{ruleName}
      POST
    • /rules/{ruleName}
      DELETE
    • /rules/{ruleName}
      GET
    • /rules/{ruleName}
      PATCH
    • /destinations
      PATCH
    • /audit/configuration
      DELETE
    • /audit/configuration
      GET
    • /audit/configuration
      PATCH
    • /audit/suppressions/delete
      POST
    • /cacertificate/{caCertificateId}
      DELETE
    • /cacertificate/{caCertificateId}
      GET
    • /cacertificate/{caCertificateId}
      PUT
    • /certificates/{certificateId}
      DELETE
    • /certificates/{certificateId}
      GET
    • /things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}
      DELETE
    • /policies/{policyName}/version/{policyVersionId}
      DELETE
    • /policies/{policyName}/version/{policyVersionId}
      GET
    • /policies/{policyName}/version/{policyVersionId}
      PATCH
    • /provisioning-templates/{templateName}
      DELETE
    • /provisioning-templates/{templateName}
      GET
    • /provisioning-templates/{templateName}
      PATCH
    • /provisioning-templates/{templateName}/versions/{versionId}
      DELETE
    • /provisioning-templates/{templateName}/versions/{versionId}
      GET
    • /registrationcode
      DELETE
    • /registrationcode
      GET
    • /destinations/{arn}
      DELETE
    • /destinations/{arn}
      GET
    • /v2LoggingLevel
      DELETE
    • /thing-types/{thingTypeName}/deprecate
      POST
    • /audit/findings/{findingId}
      GET
    • /audit/mitigationactions/tasks/{taskId}
      GET
    • /audit/mitigationactions/tasks/{taskId}
      POST
    • /audit/suppressions/describe
      POST
    • /audit/tasks/{taskId}
      GET
    • /detect/mitigationactions/tasks/{taskId}
      GET
    • /detect/mitigationactions/tasks/{taskId}
      PUT
    • /endpoint
      GET
    • /event-configurations
      GET
    • /event-configurations
      PATCH
    • /indices/{indexName}
      GET
    • /things/{thingName}/jobs/{jobId}
      GET
    • /thing-registration-tasks/{taskId}
      GET
    • /rules/{ruleName}/disable
      POST
    • /rules/{ruleName}/enable
      POST
    • /behavior-model-training/summaries
      GET
    • /indices/buckets
      POST
    • /indices/cardinality
      POST
    • /effective-policies
      POST
    • /indexing/config
      GET
    • /indexing/config
      POST
    • /jobs/{jobId}/job-document
      GET
    • /loggingOptions
      GET
    • /loggingOptions
      POST
    • /indices/percentiles
      POST
    • /indices/statistics
      POST
    • /v2LoggingOptions
      GET
    • /v2LoggingOptions
      POST
    • /active-violations
      GET
    • /attached-policies/{target}
      POST
    • /audit/findings
      POST
    • /audit/mitigationactions/executions
      GET
    • /audit/mitigationactions/tasks
      GET
    • /audit/suppressions/list
      POST
    • /audit/tasks
      GET
    • /authorizers/
      GET
    • /billing-groups
      GET
    • /cacertificates
      GET
    • /certificates-by-ca/{caCertificateId}
      GET
    • /custom-metrics
      GET
    • /detect/mitigationactions/executions
      GET
    • /detect/mitigationactions/tasks
      GET
    • /dimensions
      GET
    • /domainConfigurations
      GET
    • /fleet-metrics
      GET
    • /indices
      GET
    • /jobs/{jobId}/things
      GET
    • /things/{thingName}/jobs
      GET
    • /job-templates
      GET
    • /jobs
      GET
    • /mitigationactions/actions
      GET
    • /otaUpdates
      GET
    • /certificates-out-going
      GET
    • /policies
      GET
    • /policy-principals
      GET
    • /principal-policies
      GET
    • /principals/things
      GET
    • /role-aliases
      GET
    • /audit/scheduledaudits
      GET
    • /security-profiles
      GET
    • /security-profiles-for-target
      GET
    • /streams
      GET
    • /policy-targets/{policyName}
      POST
    • /security-profiles/{securityProfileName}/targets
      GET
    • /thing-groups
      GET
    • /things/{thingName}/thing-groups
      GET
    • /things/{thingName}/principals
      GET
    • /thing-registration-tasks/{taskId}/reports
      GET
    • /thing-registration-tasks
      GET
    • /thing-registration-tasks
      POST
    • /thing-types
      GET
    • /things
      GET
    • /things
      POST
    • /billing-groups/{billingGroupName}/things
      GET
    • /thing-groups/{thingGroupName}/things
      GET
    • /rules
      GET
    • /v2LoggingLevel
      GET
    • /v2LoggingLevel
      POST
    • /violation-events
      GET
    • /cacertificate
      POST
    • /certificate/register
      POST
    • /certificate/register-no-ca
      POST
    • /reject-certificate-transfer/{certificateId}
      PATCH
    • /billing-groups/removeThingFromBillingGroup
      PUT
    • /thing-groups/removeThingFromThingGroup
      PUT
    • /indices/search
      POST
    • /audit/tasks
      POST
    • /thing-registration-tasks/{taskId}/cancel
      PUT
    • /test-authorization
      POST
    • /authorizer/{authorizerName}/test
      POST
    • /transfer-certificate/{certificateId}
      PATCH
    • /untag
      POST
    • /audit/suppressions/update
      PATCH
    • /certificates/{certificateId}
      PUT
    • /thing-groups/updateThingGroupsForThing
      PUT
    • /security-profile-behaviors/validate
      POST

      /endpoint

      The AWS IoT Wireless multi-region endpoint
      https://api.iotwireless.{region}.amazonaws.com
      The AWS IoT Wireless multi-region endpoint
      https://api.iotwireless.{region}.amazonaws.com
      GET
      /endpoint
      Returns a unique endpoint specific to the Amazon Web Services account making the call.
      Requires permission to access the DescribeEndpoint action.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/endpoint'
      Response Response Example
      200 - Example 1
      {
    "endpointAddress": "string"
}

      Request

      Query Params
      endpointType
      string 
      optional
      The endpoint type. Valid endpoint types include:
      • iot:Data - Returns a VeriSign signed data endpoint.
      • iot:Data-ATS - Returns an ATS signed data endpoint.
      • iot:CredentialProvider - Returns an IoT credentials provider API endpoint.
      • iot:Jobs - Returns an IoT device management Jobs API endpoint.
      We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.

      Responses

      🟢200Success
      application/json
      Body
      The output from the DescribeEndpoint operation.
      endpointAddress
      string 
      optional
      The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
      🟠480InternalFailureException
      🟠481InvalidRequestException
      🟠482UnauthorizedException
      🟠483ThrottlingException
      Modified at 2022-09-10 23:12:16
      Previous
      /detect/mitigationactions/tasks/{taskId}
      Next
      /event-configurations
      Built with