AWS.Tools.IoT.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IoT</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IOT.AddIOTPolicyCmdlet"> <summary> Attaches a policy to the specified target. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy to attach.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPolicyCmdlet.Target"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-security-identity.html">identity</a> to which the policy is attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPolicyCmdlet.PassThru"> <summary> Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.AddIOTPrincipalPolicyCmdlet"> <summary> Attaches the specified policy to the specified principal (certificate or other credential). <para><b>Note:</b> This API is deprecated. Please use <a>AttachPolicy</a> instead. </para><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPrincipalPolicyCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPrincipalPolicyCmdlet.Principal"> <summary> <para> <para>The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPrincipalPolicyCmdlet.PassThru"> <summary> Returns the value passed to the Principal parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPrincipalPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.AddIOTResourceTagCmdlet"> <summary> Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTResourceTagCmdlet.Tag"> <summary> <para> <para>The new or modified tags for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.AddIOTTargetsWithJobCmdlet"> <summary> Associates a group with a continuous job. The following criteria must be met: <ul><li><para> The job must have been created with the <code>targetSelection</code> field set to "CONTINUOUS". </para></li><li><para> The job status must currently be "IN_PROGRESS". </para></li><li><para> The total number of targets associated with a job must not exceed 100. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTTargetsWithJobCmdlet.Comment"> <summary> <para> <para>An optional comment string describing why the job was associated with the targets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTTargetsWithJobCmdlet.JobId"> <summary> <para> <para>The unique identifier you assigned to this job when it was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTTargetsWithJobCmdlet.Target"> <summary> <para> <para>A list of thing group ARNs that define the targets of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTTargetsWithJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingPrincipalCmdlet"> <summary> Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingPrincipalCmdlet.Principal"> <summary> <para> <para>The principal, such as a certificate or other credential.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingPrincipalCmdlet.ThingName"> <summary> <para> <para>The name of the thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingPrincipalCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingPrincipalCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToBillingGroupCmdlet"> <summary> Adds a thing to a billing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToBillingGroupCmdlet.BillingGroupArn"> <summary> <para> <para>The ARN of the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToBillingGroupCmdlet.BillingGroupName"> <summary> <para> <para>The name of the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToBillingGroupCmdlet.ThingArn"> <summary> <para> <para>The ARN of the thing to be added to the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToBillingGroupCmdlet.ThingName"> <summary> <para> <para>The name of the thing to be added to the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToBillingGroupCmdlet.PassThru"> <summary> Returns the value passed to the ThingArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToBillingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToThingGroupCmdlet"> <summary> Adds a thing to a thing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToThingGroupCmdlet.OverrideDynamicGroup"> <summary> <para> <para>Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToThingGroupCmdlet.ThingArn"> <summary> <para> <para>The ARN of the thing to add to a group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToThingGroupCmdlet.ThingGroupArn"> <summary> <para> <para>The ARN of the group to which you are adding a thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToThingGroupCmdlet.ThingGroupName"> <summary> <para> <para>The name of the group to which you are adding a thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToThingGroupCmdlet.ThingName"> <summary> <para> <para>The name of the thing to add to a group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToThingGroupCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingToThingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.ClearIOTDefaultAuthorizerCmdlet"> <summary> Clears the default authorizer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.ClearIOTDefaultAuthorizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.ConfirmIOTCertificateTransferCmdlet"> <summary> Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. <para> To check for pending certificate transfers, call <a>ListCertificates</a> to enumerate your certificates. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.ConfirmIOTCertificateTransferCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.ConfirmIOTCertificateTransferCmdlet.SetAsActive"> <summary> <para> <para>Specifies whether the certificate is active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.ConfirmIOTCertificateTransferCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.ConfirmIOTCertificateTransferCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.DenyIOTCertificateTransferCmdlet"> <summary> Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from <b>PENDING_TRANSFER</b> to <b>INACTIVE</b>. <para> To check for pending certificate transfers, call <a>ListCertificates</a> to enumerate your certificates. </para><para> This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DenyIOTCertificateTransferCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DenyIOTCertificateTransferCmdlet.RejectReason"> <summary> <para> <para>The reason the certificate transfer was rejected.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DenyIOTCertificateTransferCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DenyIOTCertificateTransferCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.DisableIOTTopicRuleCmdlet"> <summary> Disables the rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DisableIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule to disable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DisableIOTTopicRuleCmdlet.PassThru"> <summary> Returns the value passed to the RuleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DisableIOTTopicRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.DismountIOTPolicyCmdlet"> <summary> Detaches a policy from the specified target. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DismountIOTPolicyCmdlet.PolicyName"> <summary> <para> <para>The policy to detach.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DismountIOTPolicyCmdlet.Target"> <summary> <para> <para>The target from which the policy will be detached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DismountIOTPolicyCmdlet.PassThru"> <summary> Returns the value passed to the Target parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DismountIOTPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.DismountIOTSecurityProfileCmdlet"> <summary> Disassociates a Device Defender security profile from a thing group or from this account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DismountIOTSecurityProfileCmdlet.SecurityProfileName"> <summary> <para> <para>The security profile that is detached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DismountIOTSecurityProfileCmdlet.SecurityProfileTargetArn"> <summary> <para> <para>The ARN of the thing group from which the security profile is detached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DismountIOTSecurityProfileCmdlet.PassThru"> <summary> Returns the value passed to the SecurityProfileName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DismountIOTSecurityProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.EnableIOTTopicRuleCmdlet"> <summary> Enables the rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.EnableIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the topic rule to enable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.EnableIOTTopicRuleCmdlet.PassThru"> <summary> Returns the value passed to the RuleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.EnableIOTTopicRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAccountAuditConfigurationCmdlet"> <summary> Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTActiveViolationListCmdlet"> <summary> Lists the active violations for a given Device Defender security profile.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTActiveViolationListCmdlet.SecurityProfileName"> <summary> <para> <para>The name of the Device Defender security profile for which violations are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTActiveViolationListCmdlet.ThingName"> <summary> <para> <para>The name of the thing whose active violations are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTActiveViolationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTActiveViolationListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAttachedPolicyListCmdlet"> <summary> Lists the policies attached to the specified thing group.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAttachedPolicyListCmdlet.Recursive"> <summary> <para> <para>When true, recursively list attached policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAttachedPolicyListCmdlet.Target"> <summary> <para> <para>The group or principal for which the policies will be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAttachedPolicyListCmdlet.Marker"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAttachedPolicyListCmdlet.PageSize"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingCmdlet"> <summary> Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingCmdlet.FindingId"> <summary> <para> <para>A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet"> <summary> Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.ResourceIdentifier_Account"> <summary> <para> <para>The account with which the resource is associated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.ResourceIdentifier_CaCertificateId"> <summary> <para> <para>The ID of the CA certificate used to authorize the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.CheckName"> <summary> <para> <para>A filter to limit results to the findings for the specified audit check.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.ResourceIdentifier_ClientId"> <summary> <para> <para>The client ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.ResourceIdentifier_CognitoIdentityPoolId"> <summary> <para> <para>The ID of the Amazon Cognito identity pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.ResourceIdentifier_DeviceCertificateId"> <summary> <para> <para>The ID of the certificate attached to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.EndTime"> <summary> <para> <para>A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.PolicyVersionIdentifier_PolicyName"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.PolicyVersionIdentifier_PolicyVersionId"> <summary> <para> <para>The ID of the version of the policy associated with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.StartTime"> <summary> <para> <para>A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.TaskId"> <summary> <para> <para>A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time. The default is 25.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditFindingListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsExecutionListCmdlet"> <summary> Gets the status of audit mitigation action tasks that were executed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsExecutionListCmdlet.ActionStatus"> <summary> <para> <para>Specify this filter to limit results to those with a specific status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsExecutionListCmdlet.FindingId"> <summary> <para> <para>Specify this filter to limit results to those that were applied to a specific audit finding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsExecutionListCmdlet.TaskId"> <summary> <para> <para>Specify this filter to limit results to actions for a specific audit mitigation actions task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time. The default is 25.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsExecutionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskCmdlet"> <summary> Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskCmdlet.TaskId"> <summary> <para> <para>The unique identifier for the audit mitigation task.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskListCmdlet"> <summary> Gets a list of audit mitigation action tasks that match the specified filters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskListCmdlet.AuditTaskId"> <summary> <para> <para>Specify this filter to limit results to tasks that were applied to results for a specific audit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskListCmdlet.EndTime"> <summary> <para> <para>Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskListCmdlet.FindingId"> <summary> <para> <para>Specify this filter to limit results to tasks that were applied to a specific audit finding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskListCmdlet.StartTime"> <summary> <para> <para>Specify this filter to limit results to tasks that began on or after a specific date and time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskListCmdlet.TaskStatus"> <summary> <para> <para>Specify this filter to limit results to tasks that are in a specific state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time. The default is 25.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditMitigationActionsTaskListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditTaskCmdlet"> <summary> Gets information about a Device Defender audit. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuditTaskCmdlet.TaskId"> <summary> <para> <para>The ID of the audit whose information you want to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuthorizerCmdlet"> <summary> Describes an authorizer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuthorizerCmdlet.AuthorizerName"> <summary> <para> <para>The name of the authorizer to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuthorizerListCmdlet"> <summary> Lists the authorizers registered in your account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuthorizerListCmdlet.AscendingOrder"> <summary> <para> <para>Return the list of authorizers in ascending alphabetical order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuthorizerListCmdlet.Status"> <summary> <para> <para>The status of the list authorizers request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuthorizerListCmdlet.Marker"> <summary> <para> <para>A marker used to get the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTAuthorizerListCmdlet.PageSize"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTBillingGroupCmdlet"> <summary> Returns information about a billing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTBillingGroupCmdlet.BillingGroupName"> <summary> <para> <para>The name of the billing group.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTBillingGroupListCmdlet"> <summary> Lists the billing groups you have created.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTBillingGroupListCmdlet.NamePrefixFilter"> <summary> <para> <para>Limit the results to billing groups whose names have the given prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTBillingGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTBillingGroupListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTCACertificateCmdlet"> <summary> Describes a registered CA certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCACertificateCmdlet.CertificateId"> <summary> <para> <para>The CA certificate identifier.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTCACertificateListCmdlet"> <summary> Lists the CA certificates registered for your AWS account. <para> The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCACertificateListCmdlet.AscendingOrder"> <summary> <para> <para>Determines the order of the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCACertificateListCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCACertificateListCmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateCmdlet"> <summary> Gets information about the specified certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListCmdlet"> <summary> Lists the certificates registered in your AWS account. <para> The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListCmdlet.AscendingOrder"> <summary> <para> <para>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListCmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListByCACmdlet"> <summary> List the device certificates signed by the specified CA certificate.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListByCACmdlet.AscendingOrder"> <summary> <para> <para>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListByCACmdlet.CaCertificateId"> <summary> <para> <para>The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListByCACmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListByCACmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTDefaultAuthorizerCmdlet"> <summary> Describes the default authorizer. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTEffectivePolicyCmdlet"> <summary> Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTEffectivePolicyCmdlet.CognitoIdentityPoolId"> <summary> <para> <para>The Cognito identity pool ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTEffectivePolicyCmdlet.Principal"> <summary> <para> <para>The principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTEffectivePolicyCmdlet.ThingName"> <summary> <para> <para>The thing name.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTEndpointCmdlet"> <summary> Returns a unique endpoint specific to the AWS account making the call. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTEndpointCmdlet.EndpointType"> <summary> <para> <para>The endpoint type. Valid endpoint types include:</para><ul><li><para><code>iot:Data</code> - Returns a VeriSign signed data endpoint.</para></li></ul><ul><li><para><code>iot:Data-ATS</code> - Returns an ATS signed data endpoint.</para></li></ul><ul><li><para><code>iot:CredentialProvider</code> - Returns an AWS IoT credentials provider API endpoint.</para></li></ul><ul><li><para><code>iot:Jobs</code> - Returns an AWS IoT device management Jobs API endpoint.</para></li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTEventConfigurationCmdlet"> <summary> Describes event configurations. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTIndexCmdlet"> <summary> Describes a search index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTIndexCmdlet.IndexName"> <summary> <para> <para>The index name.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTIndexingConfigurationCmdlet"> <summary> Gets the search configuration. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTIndexListCmdlet"> <summary> Lists the search indices.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTIndexListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTIndexListCmdlet.NextToken"> <summary> <para> <para>The token used to get the next set of results, or null if there are no additional results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobCmdlet"> <summary> Describes a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobCmdlet.JobId"> <summary> <para> <para>The unique identifier you assigned to this job when it was created.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobDocumentCmdlet"> <summary> Gets a job document. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobDocumentCmdlet.JobId"> <summary> <para> <para>The unique identifier you assigned to this job when it was created.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionCmdlet"> <summary> Describes a job execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionCmdlet.ExecutionNumber"> <summary> <para> <para>A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionCmdlet.JobId"> <summary> <para> <para>The unique identifier you assigned to this job when it was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionCmdlet.ThingName"> <summary> <para> <para>The name of the thing on which the job execution is running.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForJobListCmdlet"> <summary> Lists the job executions for a job.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForJobListCmdlet.JobId"> <summary> <para> <para>The unique identifier you assigned to this job when it was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForJobListCmdlet.Status"> <summary> <para> <para>The status of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForJobListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForThingListCmdlet"> <summary> Lists the job executions for the specified thing.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForThingListCmdlet.Status"> <summary> <para> <para>An optional filter that lets you search for jobs that have the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForThingListCmdlet.ThingName"> <summary> <para> <para>The thing name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForThingListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobExecutionsForThingListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobListCmdlet"> <summary> Lists jobs.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobListCmdlet.Status"> <summary> <para> <para>An optional filter that lets you search for jobs that have the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobListCmdlet.TargetSelection"> <summary> <para> <para>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobListCmdlet.ThingGroupId"> <summary> <para> <para>A filter that limits the returned jobs to those for the specified group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobListCmdlet.ThingGroupName"> <summary> <para> <para>A filter that limits the returned jobs to those for the specified group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTJobListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTLoggingOptionCmdlet"> <summary> Gets the logging options. <para> NOTE: use of this command is not recommended. Use <code>GetV2LoggingOptions</code> instead. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTMitigationActionCmdlet"> <summary> Gets information about a mitigation action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTMitigationActionCmdlet.ActionName"> <summary> <para> <para>The friendly name that uniquely identifies the mitigation action.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTMitigationActionListCmdlet"> <summary> Gets a list of all mitigation actions that match the specified filter criteria. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTMitigationActionListCmdlet.ActionType"> <summary> <para> <para>Specify a value to limit the result to mitigation actions with a specific action type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTMitigationActionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time. The default is 25.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTMitigationActionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTOTAUpdateCmdlet"> <summary> Gets an OTA update. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTOTAUpdateCmdlet.OtaUpdateId"> <summary> <para> <para>The OTA update ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTOTAUpdateListCmdlet"> <summary> Lists OTA updates.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTOTAUpdateListCmdlet.OtaUpdateStatus"> <summary> <para> <para>The OTA update job status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTOTAUpdateListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTOTAUpdateListCmdlet.NextToken"> <summary> <para> <para>A token used to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTOutgoingCertificateCmdlet"> <summary> Lists certificates that are being transferred but not yet accepted.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTOutgoingCertificateCmdlet.AscendingOrder"> <summary> <para> <para>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTOutgoingCertificateCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTOutgoingCertificateCmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyCmdlet"> <summary> Gets information about the specified policy with the policy document of the default version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyListCmdlet"> <summary> Lists your policies.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyListCmdlet.AscendingOrder"> <summary> <para> <para>Specifies the order for results. If true, the results are returned in ascending creation order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyListCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyListCmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyPrincipalListCmdlet"> <summary> Lists the principals associated with the specified policy. <para><b>Note:</b> This API is deprecated. Please use <a>ListTargetsForPolicy</a> instead. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyPrincipalListCmdlet.AscendingOrder"> <summary> <para> <para>Specifies the order for results. If true, the results are returned in ascending creation order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyPrincipalListCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyPrincipalListCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyPrincipalListCmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionCmdlet"> <summary> Gets information about the specified policy version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionCmdlet.PolicyName"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionCmdlet.PolicyVersionId"> <summary> <para> <para>The policy version ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionListCmdlet"> <summary> Lists the versions of the specified policy and identifies the default version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionListCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet"> <summary> Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in <a href="https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax">AmazonCognito Identity format</a>. <para><b>Note:</b> This API is deprecated. Please use <a>ListAttachedPolicies</a> instead. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet.AscendingOrder"> <summary> <para> <para>Specifies the order for results. If true, results are returned in ascending creation order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet.Principal"> <summary> <para> <para>The principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalThingListCmdlet"> <summary> Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalThingListCmdlet.Principal"> <summary> <para> <para>The principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalThingListCmdlet.Marker"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalThingListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this operation.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTRegistrationCodeCmdlet"> <summary> Gets a registration code used to register a CA certificate with AWS IoT. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTRoleAliasCmdlet"> <summary> Describes a role alias. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTRoleAliasCmdlet.RoleAlias"> <summary> <para> <para>The role alias to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTRoleAliasListCmdlet"> <summary> Lists the role aliases registered in your account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTRoleAliasListCmdlet.AscendingOrder"> <summary> <para> <para>Return the list of role aliases in ascending alphabetical order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTRoleAliasListCmdlet.Marker"> <summary> <para> <para>A marker used to get the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTRoleAliasListCmdlet.PageSize"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTScheduledAuditCmdlet"> <summary> Gets information about a scheduled audit. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTScheduledAuditCmdlet.ScheduledAuditName"> <summary> <para> <para>The name of the scheduled audit whose information you want to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTScheduledAuditListCmdlet"> <summary> Lists all of your scheduled audits.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTScheduledAuditListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time. The default is 25.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTScheduledAuditListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfileCmdlet"> <summary> Gets information about a Device Defender security profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfileCmdlet.SecurityProfileName"> <summary> <para> <para>The name of the security profile whose information you want to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfileListCmdlet"> <summary> Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfileListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfilesForTargetListCmdlet"> <summary> Lists the Device Defender security profiles attached to a target (thing group).<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfilesForTargetListCmdlet.Recursive"> <summary> <para> <para>If true, return child groups too.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfilesForTargetListCmdlet.SecurityProfileTargetArn"> <summary> <para> <para>The ARN of the target (thing group) whose attached security profiles you want to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfilesForTargetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTSecurityProfilesForTargetListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTStatisticCmdlet"> <summary> Gets statistics about things that match the specified query. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTStatisticCmdlet.AggregationField"> <summary> <para> <para>The aggregation field name. Currently not supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTStatisticCmdlet.IndexName"> <summary> <para> <para>The name of the index to search. The default value is <code>AWS_Things</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTStatisticCmdlet.QueryString"> <summary> <para> <para>The query used to search. You can specify "*" for the query string to get the count of all indexed things in your AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTStatisticCmdlet.QueryVersion"> <summary> <para> <para>The version of the query used to search.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTStreamCmdlet"> <summary> Gets information about a stream. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTStreamCmdlet.StreamId"> <summary> <para> <para>The stream ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTStreamListCmdlet"> <summary> Lists all of the streams in your AWS account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTStreamListCmdlet.AscendingOrder"> <summary> <para> <para>Set to true to return the list of streams in ascending order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTStreamListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTStreamListCmdlet.NextToken"> <summary> <para> <para>A token used to get the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTTagListForResourceCmdlet"> <summary> Lists the tags (metadata) you have assigned to the resource.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTagListForResourceCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTagListForResourceCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTTargetsForPolicyListCmdlet"> <summary> List targets for the specified policy.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTargetsForPolicyListCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTargetsForPolicyListCmdlet.Marker"> <summary> <para> <para>A marker used to get the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTargetsForPolicyListCmdlet.PageSize"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTTargetsForSecurityProfileListCmdlet"> <summary> Lists the targets (thing groups) associated with a given Device Defender security profile.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTargetsForSecurityProfileListCmdlet.SecurityProfileName"> <summary> <para> <para>The security profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTargetsForSecurityProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTargetsForSecurityProfileListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTTaskListCmdlet"> <summary> Lists the Device Defender audits that have been performed during a given time period.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTaskListCmdlet.UtcEndTime"> <summary> <para> <para>The end of the time period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTaskListCmdlet.UtcStartTime"> <summary> <para> <para>The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTaskListCmdlet.TaskStatus"> <summary> <para> <para>A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTaskListCmdlet.TaskType"> <summary> <para> <para>A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTaskListCmdlet.EndTime"> <summary> <para> <para>This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc results in both EndTime and EndTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. EndTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.</para><para>The end of the time period.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTaskListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time. The default is 25.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTaskListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTaskListCmdlet.StartTime"> <summary> <para> <para>This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. StartTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.</para><para>The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingCmdlet"> <summary> Gets information about the specified thing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingCmdlet.ThingName"> <summary> <para> <para>The name of the thing.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupCmdlet"> <summary> Describe a thing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupCmdlet.ThingGroupName"> <summary> <para> <para>The name of the thing group.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupListCmdlet"> <summary> List the thing groups in your account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupListCmdlet.NamePrefixFilter"> <summary> <para> <para>A filter that limits the results to those with the specified name prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupListCmdlet.ParentGroup"> <summary> <para> <para>A filter that limits the results to those with the specified parent group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupListCmdlet.Recursive"> <summary> <para> <para>If true, return child groups as well.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupsForThingListCmdlet"> <summary> List the thing groups to which the specified thing belongs.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupsForThingListCmdlet.ThingName"> <summary> <para> <para>The thing name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupsForThingListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingGroupsForThingListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet"> <summary> Lists your things. Use the <b>attributeName</b> and <b>attributeValue</b> parameters to filter your things. For example, calling <code>ListThings</code> with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute <b>Color</b> with the value <b>Red</b>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet.AttributeName"> <summary> <para> <para>The attribute name used to search for things.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet.AttributeValue"> <summary> <para> <para>The attribute value used to search for things.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet.ThingTypeName"> <summary> <para> <para>The name of the thing type used to search for things.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet.Marker"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this operation.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingPrincipalListCmdlet"> <summary> Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingPrincipalListCmdlet.ThingName"> <summary> <para> <para>The name of the thing.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskCmdlet"> <summary> Describes a bulk thing provisioning task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskCmdlet.TaskId"> <summary> <para> <para>The task ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskListCmdlet"> <summary> List bulk thing provisioning tasks.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskListCmdlet.Status"> <summary> <para> <para>The status of the bulk thing provisioning task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskReportListCmdlet"> <summary> Information about the thing registration tasks.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskReportListCmdlet.ReportType"> <summary> <para> <para>The type of task report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskReportListCmdlet.TaskId"> <summary> <para> <para>The id of the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskReportListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingRegistrationTaskReportListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingsInBillingGroupListCmdlet"> <summary> Lists the things you have added to the given billing group.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingsInBillingGroupListCmdlet.BillingGroupName"> <summary> <para> <para>The name of the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingsInBillingGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingsInBillingGroupListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingsInThingGroupListCmdlet"> <summary> Lists the things in the specified group.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingsInThingGroupListCmdlet.Recursive"> <summary> <para> <para>When true, list things in this thing group and in all child groups as well.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingsInThingGroupListCmdlet.ThingGroupName"> <summary> <para> <para>The thing group name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingsInThingGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingsInThingGroupListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingTypeCmdlet"> <summary> Gets information about the specified thing type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingTypeCmdlet.ThingTypeName"> <summary> <para> <para>The name of the thing type.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingTypeListCmdlet"> <summary> Lists the existing thing types.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingTypeListCmdlet.ThingTypeName"> <summary> <para> <para>The name of the thing type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingTypeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingTypeListCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleCmdlet"> <summary> Gets information about the rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet"> <summary> Lists the rules for the specific topic.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet.RuleDisabled"> <summary> <para> <para>Specifies whether the rule is disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet.Topic"> <summary> <para> <para>The topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet.Marker"> <summary> <para> <para>A token used to retrieve the next value.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTV2LoggingLevelListCmdlet"> <summary> Lists logging levels.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTV2LoggingLevelListCmdlet.TargetType"> <summary> <para> <para>The type of resource for which you are configuring logging. Must be <code>THING_Group</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTV2LoggingLevelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTV2LoggingLevelListCmdlet.NextToken"> <summary> <para> <para>The token used to get the next set of results, or <b>null</b> if there are no additional results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTV2LoggingOptionCmdlet"> <summary> Gets the fine grained logging options. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTViolationEventListCmdlet"> <summary> Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTViolationEventListCmdlet.UtcEndTime"> <summary> <para> <para>The end time for the alerts to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTViolationEventListCmdlet.SecurityProfileName"> <summary> <para> <para>A filter to limit results to those alerts generated by the specified security profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTViolationEventListCmdlet.UtcStartTime"> <summary> <para> <para>The start time for the alerts to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTViolationEventListCmdlet.ThingName"> <summary> <para> <para>A filter to limit results to those alerts caused by the specified thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTViolationEventListCmdlet.EndTime"> <summary> <para> <para>This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc results in both EndTime and EndTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. EndTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.</para><para>The end time for the alerts to be listed.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTViolationEventListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTViolationEventListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTViolationEventListCmdlet.StartTime"> <summary> <para> <para>This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. StartTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.</para><para>The start time for the alerts to be listed.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.MountIOTSecurityProfileCmdlet"> <summary> Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.MountIOTSecurityProfileCmdlet.SecurityProfileName"> <summary> <para> <para>The security profile that is attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.MountIOTSecurityProfileCmdlet.SecurityProfileTargetArn"> <summary> <para> <para>The ARN of the target (thing group) to which the security profile is attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.MountIOTSecurityProfileCmdlet.PassThru"> <summary> Returns the value passed to the SecurityProfileName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.MountIOTSecurityProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTAuthorizerCmdlet"> <summary> Creates an authorizer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTAuthorizerCmdlet.AuthorizerFunctionArn"> <summary> <para> <para>The ARN of the authorizer's Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTAuthorizerCmdlet.AuthorizerName"> <summary> <para> <para>The authorizer name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTAuthorizerCmdlet.Status"> <summary> <para> <para>The status of the create authorizer request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTAuthorizerCmdlet.TokenKeyName"> <summary> <para> <para>The name of the token key used to extract the token from the HTTP headers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTAuthorizerCmdlet.TokenSigningPublicKey"> <summary> <para> <para>The public keys used to verify the digital signature returned by your custom authentication service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTAuthorizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTBillingGroupCmdlet"> <summary> Creates a billing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTBillingGroupCmdlet.BillingGroupProperties_BillingGroupDescription"> <summary> <para> <para>The description of the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTBillingGroupCmdlet.BillingGroupName"> <summary> <para> <para>The name you wish to give to the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTBillingGroupCmdlet.Tag"> <summary> <para> <para>Metadata which can be used to manage the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTBillingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTCertificateFromCsrCmdlet"> <summary> Creates an X.509 certificate using the specified certificate signing request. <para><b>Note:</b> The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. </para><para><b>Note:</b> Reusing the same certificate signing request (CSR) results in a distinct certificate. </para><para> You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. </para><para> Assuming a set of CSRs are located inside of the directory my-csr-directory: </para><para> On Linux and OS X, the command is: </para><para> $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} </para><para> This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR. </para><para> The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: </para><para> $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} </para><para> On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: </para><para> > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} </para><para> On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: </para><para> > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path" </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTCertificateFromCsrCmdlet.CertificateSigningRequest"> <summary> <para> <para>The certificate signing request (CSR).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTCertificateFromCsrCmdlet.SetAsActive"> <summary> <para> <para>Specifies whether the certificate is active.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTDynamicThingGroupCmdlet"> <summary> Creates a dynamic thing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTDynamicThingGroupCmdlet.ThingGroupProperties_AttributePayload"> <summary> <para> <para>The thing group attributes in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTDynamicThingGroupCmdlet.IndexName"> <summary> <para> <para>The dynamic thing group index name.</para><note><para>Currently one index is supported: "AWS_Things".</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTDynamicThingGroupCmdlet.QueryString"> <summary> <para> <para>The dynamic thing group search query string.</para><para>See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query Syntax</a> for information about query string syntax.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTDynamicThingGroupCmdlet.QueryVersion"> <summary> <para> <para>The dynamic thing group query version.</para><note><para>Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTDynamicThingGroupCmdlet.Tag"> <summary> <para> <para>Metadata which can be used to manage the dynamic thing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTDynamicThingGroupCmdlet.ThingGroupProperties_ThingGroupDescription"> <summary> <para> <para>The thing group description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTDynamicThingGroupCmdlet.ThingGroupName"> <summary> <para> <para>The dynamic thing group name to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTDynamicThingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet"> <summary> Creates a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.AbortConfig_CriteriaList"> <summary> <para> <para>The list of abort criteria to define rules to abort the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.Description"> <summary> <para> <para>A short text description of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.Document"> <summary> <para> <para>The job document.</para><note><para>If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.</para><para>The placeholder link is of the following form:</para><para><code>${aws:iot:s3-presigned-url:https://s3.amazonaws.com/<i>bucket</i>/<i>key</i>}</code></para><para>where <i>bucket</i> is your bucket name and <i>key</i> is the object in the bucket to which you are linking.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.DocumentSource"> <summary> <para> <para>An S3 link to the job document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.PresignedUrlConfig_ExpiresInSec"> <summary> <para> <para>How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.JobExecutionsRolloutConfig_ExponentialRate"> <summary> <para> <para>The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.TimeoutConfig_InProgressTimeoutInMinute"> <summary> <para> <para>Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal <code>TIMED_OUT</code> status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.JobId"> <summary> <para> <para>A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.JobExecutionsRolloutConfig_MaximumPerMinute"> <summary> <para> <para>The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.PresignedUrlConfig_RoleArn"> <summary> <para> <para>The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.Tag"> <summary> <para> <para>Metadata which can be used to manage the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.Target"> <summary> <para> <para>A list of things and thing groups to which the job should be sent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.TargetSelection"> <summary> <para> <para>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTKeysAndCertificateCmdlet"> <summary> Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. <para><b>Note</b> This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTKeysAndCertificateCmdlet.SetAsActive"> <summary> <para> <para>Specifies whether the certificate is active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTKeysAndCertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet"> <summary> Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.UpdateCACertificateParams_Action"> <summary> <para> <para>The action that you want to apply to the CA cerrtificate. The only supported value is <code>DEACTIVATE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.UpdateDeviceCertificateParams_Action"> <summary> <para> <para>The action that you want to apply to the device cerrtificate. The only supported value is <code>DEACTIVATE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.ActionName"> <summary> <para> <para>A friendly name for the action. Choose a friendly name that accurately describes the action (for example, <code>EnableLoggingAction</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.EnableIoTLoggingParams_LogLevel"> <summary> <para> <para>Specifies the types of information to be logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.AddThingsToThingGroupParams_OverrideDynamicGroup"> <summary> <para> <para>Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.RoleArn"> <summary> <para> <para>The ARN of the IAM role that is used to apply the mitigation action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.EnableIoTLoggingParams_RoleArnForLogging"> <summary> <para> <para>The ARN of the IAM role used for logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the mitigation action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.ReplaceDefaultPolicyVersionParams_TemplateName"> <summary> <para> <para>The name of the template to be applied. The only supported value is <code>BLANK_POLICY</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.AddThingsToThingGroupParams_ThingGroupName"> <summary> <para> <para>The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.PublishFindingToSnsParams_TopicArn"> <summary> <para> <para>The ARN of the topic to which you want to publish the findings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTMitigationActionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet"> <summary> Creates an AWS IoT OTAUpdate on a target group of things or groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.AdditionalParameter"> <summary> <para> <para>A list of additional OTA update parameters which are name-value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.Description"> <summary> <para> <para>The description of the OTA update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.File"> <summary> <para> <para>The files to be streamed by the OTA update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.AwsJobExecutionsRolloutConfig_MaximumPerMinute"> <summary> <para> <para>The maximum number of OTA update job executions started per minute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.OtaUpdateId"> <summary> <para> <para>The ID of the OTA update to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.RoleArn"> <summary> <para> <para>The IAM role that allows access to the AWS IoT Jobs service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.Tag"> <summary> <para> <para>Metadata which can be used to manage updates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.Target"> <summary> <para> <para>The targeted devices to receive OTA updates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.TargetSelection"> <summary> <para> <para>Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTOTAUpdateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyCmdlet"> <summary> Creates an AWS IoT policy. <para> The created policy is the default version for the policy. This operation creates a policy version with a version identifier of <b>1</b> and sets <b>1</b> as the policy's default version. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyCmdlet.PolicyDocument"> <summary> <para> <para>The JSON document that describes the policy. <b>policyDocument</b> must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyVersionCmdlet"> <summary> Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use <a>DeletePolicyVersion</a> to delete an existing version before you create a new one. <para> Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyVersionCmdlet.PolicyDocument"> <summary> <para> <para>The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyVersionCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyVersionCmdlet.SetAsDefault"> <summary> <para> <para>Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTRoleAliasCmdlet"> <summary> Creates a role alias. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTRoleAliasCmdlet.CredentialDurationSecond"> <summary> <para> <para>How long (in seconds) the credentials will be valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTRoleAliasCmdlet.RoleAlias"> <summary> <para> <para>The role alias that points to a role ARN. This allows you to change the role without having to update the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTRoleAliasCmdlet.RoleArn"> <summary> <para> <para>The role ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTRoleAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTScheduledAuditCmdlet"> <summary> Creates a scheduled audit that is run at a specified time interval. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTScheduledAuditCmdlet.DayOfMonth"> <summary> <para> <para>The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTScheduledAuditCmdlet.DayOfWeek"> <summary> <para> <para>The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTScheduledAuditCmdlet.Frequency"> <summary> <para> <para>How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTScheduledAuditCmdlet.ScheduledAuditName"> <summary> <para> <para>The name you want to give to the scheduled audit. (Max. 128 chars)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTScheduledAuditCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the scheduled audit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTScheduledAuditCmdlet.TargetCheckName"> <summary> <para> <para>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTScheduledAuditCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTSecurityProfileCmdlet"> <summary> Creates a Device Defender security profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTSecurityProfileCmdlet.AdditionalMetricsToRetain"> <summary> <para> <para>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTSecurityProfileCmdlet.AlertTarget"> <summary> <para> <para>Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTSecurityProfileCmdlet.Behavior"> <summary> <para> <para>Specifies the behaviors that, when violated by a device (thing), cause an alert.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTSecurityProfileCmdlet.SecurityProfileDescription"> <summary> <para> <para>A description of the security profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTSecurityProfileCmdlet.SecurityProfileName"> <summary> <para> <para>The name you are giving to the security profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTSecurityProfileCmdlet.Tag"> <summary> <para> <para>Metadata that can be used to manage the security profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTSecurityProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTStreamCmdlet"> <summary> Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTStreamCmdlet.Description"> <summary> <para> <para>A description of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTStreamCmdlet.File"> <summary> <para> <para>The files to stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTStreamCmdlet.RoleArn"> <summary> <para> <para>An IAM role that allows the IoT service principal assumes to access your S3 files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTStreamCmdlet.StreamId"> <summary> <para> <para>The stream ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTStreamCmdlet.Tag"> <summary> <para> <para>Metadata which can be used to manage streams.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTStreamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingCmdlet"> <summary> Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a <code>ResourceAlreadyExistsException</code> is thrown. <note><para> This is a control plane operation. See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html">Authorization</a> for information about authorizing control plane actions. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingCmdlet.AttributePayload"> <summary> <para> <para>The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:</para><para><code>{\"attributes\":{\"string1\":\"string2\"}}</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingCmdlet.BillingGroupName"> <summary> <para> <para>The name of the billing group the thing will be added to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingCmdlet.ThingName"> <summary> <para> <para>The name of the thing to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingCmdlet.ThingTypeName"> <summary> <para> <para>The name of the thing type associated with the new thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingGroupCmdlet"> <summary> Create a thing group. <note><para> This is a control plane operation. See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html">Authorization</a> for information about authorizing control plane actions. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingGroupCmdlet.ThingGroupProperties_AttributePayload"> <summary> <para> <para>The thing group attributes in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingGroupCmdlet.ParentGroupName"> <summary> <para> <para>The name of the parent thing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingGroupCmdlet.Tag"> <summary> <para> <para>Metadata which can be used to manage the thing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingGroupCmdlet.ThingGroupProperties_ThingGroupDescription"> <summary> <para> <para>The thing group description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingGroupCmdlet.ThingGroupName"> <summary> <para> <para>The thing group name to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingTypeCmdlet"> <summary> Creates a new thing type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingTypeCmdlet.ThingTypeProperties_SearchableAttribute"> <summary> <para> <para>A list of searchable thing attribute names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingTypeCmdlet.Tag"> <summary> <para> <para>Metadata which can be used to manage the thing type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingTypeCmdlet.ThingTypeProperties_ThingTypeDescription"> <summary> <para> <para>The description of the thing type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingTypeCmdlet.ThingTypeName"> <summary> <para> <para>The name of the thing type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingTypeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet"> <summary> Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.TopicRulePayload_Action"> <summary> <para> <para>The actions associated with the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchAlarm_AlarmName"> <summary> <para> <para>The CloudWatch alarm name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.TopicRulePayload_AwsIotSqlVersion"> <summary> <para> <para>The version of the SQL rules engine to use when evaluating the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.S3_BucketName"> <summary> <para> <para>The Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.S3_CannedAcl"> <summary> <para> <para>The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl">S3 canned ACLs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.IotAnalytics_ChannelArn"> <summary> <para> <para>(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.IotAnalytics_ChannelName"> <summary> <para> <para>The name of the IoT Analytics channel to which message data will be sent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Firehose_DeliveryStreamName"> <summary> <para> <para>The delivery stream name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.TopicRulePayload_Description"> <summary> <para> <para>The description of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Elasticsearch_Endpoint"> <summary> <para> <para>The endpoint of your Elasticsearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.StepFunctions_ExecutionNamePrefix"> <summary> <para> <para>(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Lambda_FunctionArn"> <summary> <para> <para>The ARN of the Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_HashKeyField"> <summary> <para> <para>The hash key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_HashKeyType"> <summary> <para> <para>The hash key type. Valid values are "STRING" or "NUMBER"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_HashKeyValue"> <summary> <para> <para>The hash key value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Elasticsearch_Id"> <summary> <para> <para>The unique identifier for the document you are storing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Elasticsearch_Index"> <summary> <para> <para>The Elasticsearch index where you want to store your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.IotEvents_InputName"> <summary> <para> <para>The name of the AWS IoT Events input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.S3_Key"> <summary> <para> <para>The object key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Sns_MessageFormat"> <summary> <para> <para>(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see <a href="https://docs.aws.amazon.com/sns/latest/dg/json-formats.html">https://docs.aws.amazon.com/sns/latest/dg/json-formats.html</a> refer to their official documentation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.IotEvents_MessageId"> <summary> <para> <para>[Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchMetric_MetricName"> <summary> <para> <para>The CloudWatch metric name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchMetric_MetricNamespace"> <summary> <para> <para>The CloudWatch metric namespace name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchMetric_MetricTimestamp"> <summary> <para> <para>An optional <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp">Unix timestamp</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchMetric_MetricUnit"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit">metric unit</a> supported by CloudWatch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchMetric_MetricValue"> <summary> <para> <para>The CloudWatch metric value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_Operation"> <summary> <para> <para>The type of operation to be performed. This follows the substitution template, so it can be <code>${operation}</code>, but the substitution must result in one of the following: <code>INSERT</code>, <code>UPDATE</code>, or <code>DELETE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Kinesis_PartitionKey"> <summary> <para> <para>The partition key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_PayloadField"> <summary> <para> <para>The action payload. This name can be customized.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Republish_Qo"> <summary> <para> <para>The Quality of Service (QoS) level to use when republishing messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Sqs_QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_RangeKeyField"> <summary> <para> <para>The range key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_RangeKeyType"> <summary> <para> <para>The range key type. Valid values are "STRING" or "NUMBER"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_RangeKeyValue"> <summary> <para> <para>The range key value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchAlarm_RoleArn"> <summary> <para> <para>The IAM role that allows access to the CloudWatch alarm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchMetric_RoleArn"> <summary> <para> <para>The IAM role that allows access to the CloudWatch metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access to the DynamoDB table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDBv2_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access to the DynamoDB table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Elasticsearch_RoleArn"> <summary> <para> <para>The IAM role ARN that has access to Elasticsearch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Firehose_RoleArn"> <summary> <para> <para>The IAM role that grants access to the Amazon Kinesis Firehose stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.IotAnalytics_RoleArn"> <summary> <para> <para>The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.IotEvents_RoleArn"> <summary> <para> <para>The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Kinesis_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access to the Amazon Kinesis stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Republish_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.S3_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Sns_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Sqs_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.StepFunctions_RoleArn"> <summary> <para> <para>The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.TopicRulePayload_RuleDisabled"> <summary> <para> <para>Specifies whether the rule is disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Firehose_Separator"> <summary> <para> <para>A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.TopicRulePayload_Sql"> <summary> <para> <para>The SQL statement used to query the topic. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference">AWS IoT SQL Reference</a> in the <i>AWS IoT Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.StepFunctions_StateMachineName"> <summary> <para> <para>The name of the Step Functions state machine whose execution will be started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchAlarm_StateReason"> <summary> <para> <para>The reason for the alarm change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.CloudwatchAlarm_StateValue"> <summary> <para> <para>The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Kinesis_StreamName"> <summary> <para> <para>The name of the Amazon Kinesis stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.DynamoDB_TableName"> <summary> <para> <para>The name of the DynamoDB table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.PutItem_TableName"> <summary> <para> <para>The table where the message data will be written.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Tag"> <summary> <para> <para>Metadata which can be used to manage the topic rule.</para><note><para>For URI Request parameters use format: ...key1=value1&key2=value2...</para><para>For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."</para><para>For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Sns_TargetArn"> <summary> <para> <para>The ARN of the SNS topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Salesforce_Token"> <summary> <para> <para>The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Republish_Topic"> <summary> <para> <para>The name of the MQTT topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Elasticsearch_Type"> <summary> <para> <para>The type of document you are storing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Salesforce_Url"> <summary> <para> <para>The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Sqs_UseBase64"> <summary> <para> <para>Specifies whether to use Base64 encoding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCACertificateCmdlet"> <summary> Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCACertificateCmdlet.AllowAutoRegistration"> <summary> <para> <para>Allows this CA certificate to be used for auto registration of device certificates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCACertificateCmdlet.CaCertificate"> <summary> <para> <para>The CA certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCACertificateCmdlet.RegistrationConfig_RoleArn"> <summary> <para> <para>The ARN of the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCACertificateCmdlet.SetAsActive"> <summary> <para> <para>A boolean value that specifies if the CA certificate is set to active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCACertificateCmdlet.RegistrationConfig_TemplateBody"> <summary> <para> <para>The template body.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCACertificateCmdlet.VerificationCertificate"> <summary> <para> <para>The private key verification certificate.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCertificateCmdlet"> <summary> Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCertificateCmdlet.CaCertificatePem"> <summary> <para> <para>The CA certificate used to sign the device certificate being registered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCertificateCmdlet.CertificatePem"> <summary> <para> <para>The certificate data, in PEM format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCertificateCmdlet.Status"> <summary> <para> <para>The status of the register certificate request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTCertificateCmdlet.SetAsActive"> <summary> <para> <para>A boolean value that specifies if the certificate is set to active.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTThingCmdlet"> <summary> Provisions a thing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTThingCmdlet.Parameter"> <summary> <para> <para>The parameters for provisioning a thing. See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html">Programmatic Provisioning</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTThingCmdlet.TemplateBody"> <summary> <para> <para>The provisioning template. See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html">Programmatic Provisioning</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RegisterIOTThingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTAccountAuditConfigurationCmdlet"> <summary> Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTAccountAuditConfigurationCmdlet.DeleteScheduledAudit"> <summary> <para> <para>If true, all scheduled audits are deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTAccountAuditConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the DeleteScheduledAudit parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTAccountAuditConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTAuthorizerCmdlet"> <summary> Deletes an authorizer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTAuthorizerCmdlet.AuthorizerName"> <summary> <para> <para>The name of the authorizer to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTAuthorizerCmdlet.PassThru"> <summary> Returns the value passed to the AuthorizerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTAuthorizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTBillingGroupCmdlet"> <summary> Deletes the billing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTBillingGroupCmdlet.BillingGroupName"> <summary> <para> <para>The name of the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTBillingGroupCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the <code>DeleteBillingGroup</code> request is rejected with a <code>VersionConflictException</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTBillingGroupCmdlet.PassThru"> <summary> Returns the value passed to the BillingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTBillingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCACertificateCmdlet"> <summary> Deletes a registered CA certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCACertificateCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCACertificateCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCACertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCertificateCmdlet"> <summary> Deletes the specified certificate. <para> A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the <a>DetachPrincipalPolicy</a> API to detach all policies. Next, use the <a>UpdateCertificate</a> API to set the certificate to the INACTIVE status. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCertificateCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCertificateCmdlet.DeleteWithForce"> <summary> <para> <para>Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCertificateCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTDynamicThingGroupCmdlet"> <summary> Deletes a dynamic thing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTDynamicThingGroupCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the dynamic thing group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTDynamicThingGroupCmdlet.ThingGroupName"> <summary> <para> <para>The name of the dynamic thing group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTDynamicThingGroupCmdlet.PassThru"> <summary> Returns the value passed to the ThingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTDynamicThingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobCmdlet"> <summary> Deletes a job and its related job executions. <para> Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. </para><para> Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobCmdlet.Enforce"> <summary> <para> <para>(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.</para><note><para>Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobCmdlet.JobId"> <summary> <para> <para>The ID of the job to be deleted.</para><para>After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobCmdlet.PassThru"> <summary> Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobExecutionCmdlet"> <summary> Deletes a job execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobExecutionCmdlet.ExecutionNumber"> <summary> <para> <para>The ID of the job execution to be deleted. The <code>executionNumber</code> refers to the execution of a particular job on a particular device.</para><para>Note that once a job execution is deleted, the <code>executionNumber</code> may be reused by IoT, so be sure you get and use the correct value here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobExecutionCmdlet.Enforce"> <summary> <para> <para>(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.</para><note><para>Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobExecutionCmdlet.JobId"> <summary> <para> <para>The ID of the job whose execution on a particular device will be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobExecutionCmdlet.ThingName"> <summary> <para> <para>The name of the thing whose job execution will be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobExecutionCmdlet.PassThru"> <summary> Returns the value passed to the ExecutionNumber parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTJobExecutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTMitigationActionCmdlet"> <summary> Deletes a defined mitigation action from your AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTMitigationActionCmdlet.ActionName"> <summary> <para> <para>The name of the mitigation action that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTMitigationActionCmdlet.PassThru"> <summary> Returns the value passed to the ActionName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTMitigationActionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTOTAUpdateCmdlet"> <summary> Delete an OTA update. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTOTAUpdateCmdlet.DeleteStream"> <summary> <para> <para>Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTOTAUpdateCmdlet.ForceDeleteAWSJob"> <summary> <para> <para>Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTOTAUpdateCmdlet.OtaUpdateId"> <summary> <para> <para>The OTA update ID to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTOTAUpdateCmdlet.PassThru"> <summary> Returns the value passed to the OtaUpdateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTOTAUpdateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyCmdlet"> <summary> Deletes the specified policy. <para> A policy cannot be deleted if it has non-default versions or it is attached to any certificate. </para><para> To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy. </para><para> When a policy is deleted using DeletePolicy, its default version is deleted with it. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyCmdlet.PassThru"> <summary> Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyVersionCmdlet"> <summary> Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use ListPolicyVersions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyVersionCmdlet.PolicyName"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyVersionCmdlet.PolicyVersionId"> <summary> <para> <para>The policy version ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyVersionCmdlet.PassThru"> <summary> Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPrincipalPolicyCmdlet"> <summary> Removes the specified policy from the specified certificate. <para><b>Note:</b> This API is deprecated. Please use <a>DetachPolicy</a> instead. </para><br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPrincipalPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy to detach.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPrincipalPolicyCmdlet.Principal"> <summary> <para> <para>The principal.</para><para>If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPrincipalPolicyCmdlet.PassThru"> <summary> Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPrincipalPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTRegistrationCodeCmdlet"> <summary> Deletes a CA certificate registration code. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTResourceTagCmdlet"> <summary> Removes the given tags (metadata) from the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of the keys of the tags to be removed from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTRoleAliasCmdlet"> <summary> Deletes a role alias </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTRoleAliasCmdlet.RoleAlias"> <summary> <para> <para>The role alias to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTRoleAliasCmdlet.PassThru"> <summary> Returns the value passed to the RoleAlias parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTRoleAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTScheduledAuditCmdlet"> <summary> Deletes a scheduled audit. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTScheduledAuditCmdlet.ScheduledAuditName"> <summary> <para> <para>The name of the scheduled audit you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTScheduledAuditCmdlet.PassThru"> <summary> Returns the value passed to the ScheduledAuditName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTScheduledAuditCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTSecurityProfileCmdlet"> <summary> Deletes a Device Defender security profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTSecurityProfileCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a <code>VersionConflictException</code> is thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTSecurityProfileCmdlet.SecurityProfileName"> <summary> <para> <para>The name of the security profile to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTSecurityProfileCmdlet.PassThru"> <summary> Returns the value passed to the SecurityProfileName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTSecurityProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTStreamCmdlet"> <summary> Deletes a stream. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTStreamCmdlet.StreamId"> <summary> <para> <para>The stream ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTStreamCmdlet.PassThru"> <summary> Returns the value passed to the StreamId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTStreamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingCmdlet"> <summary> Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the <code>DeleteThing</code> request is rejected with a <code>VersionConflictException</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingCmdlet.ThingName"> <summary> <para> <para>The name of the thing to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromBillingGroupCmdlet"> <summary> Removes the given thing from the billing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromBillingGroupCmdlet.BillingGroupArn"> <summary> <para> <para>The ARN of the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromBillingGroupCmdlet.BillingGroupName"> <summary> <para> <para>The name of the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromBillingGroupCmdlet.ThingArn"> <summary> <para> <para>The ARN of the thing to be removed from the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromBillingGroupCmdlet.ThingName"> <summary> <para> <para>The name of the thing to be removed from the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromBillingGroupCmdlet.PassThru"> <summary> Returns the value passed to the ThingArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromBillingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromThingGroupCmdlet"> <summary> Remove the specified thing from the specified group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromThingGroupCmdlet.ThingArn"> <summary> <para> <para>The ARN of the thing to remove from the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromThingGroupCmdlet.ThingGroupArn"> <summary> <para> <para>The group ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromThingGroupCmdlet.ThingGroupName"> <summary> <para> <para>The group name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromThingGroupCmdlet.ThingName"> <summary> <para> <para>The name of the thing to remove from the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromThingGroupCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingFromThingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingGroupCmdlet"> <summary> Deletes a thing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingGroupCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the thing group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingGroupCmdlet.ThingGroupName"> <summary> <para> <para>The name of the thing group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingGroupCmdlet.PassThru"> <summary> Returns the value passed to the ThingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingPrincipalCmdlet"> <summary> Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. <note><para> This call is asynchronous. It might take several seconds for the detachment to propagate. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingPrincipalCmdlet.Principal"> <summary> <para> <para>If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingPrincipalCmdlet.ThingName"> <summary> <para> <para>The name of the thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingPrincipalCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingPrincipalCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingTypeCmdlet"> <summary> Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling <a>DeprecateThingType</a>, then remove any associated things by calling <a>UpdateThing</a> to change the thing type on any associated thing, and finally use <a>DeleteThingType</a> to delete the thing type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingTypeCmdlet.ThingTypeName"> <summary> <para> <para>The name of the thing type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingTypeCmdlet.PassThru"> <summary> Returns the value passed to the ThingTypeName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingTypeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTTopicRuleCmdlet"> <summary> Deletes the rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTTopicRuleCmdlet.PassThru"> <summary> Returns the value passed to the RuleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTTopicRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTV2LoggingLevelCmdlet"> <summary> Deletes a logging level. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTV2LoggingLevelCmdlet.TargetName"> <summary> <para> <para>The name of the resource for which you are configuring logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTV2LoggingLevelCmdlet.TargetType"> <summary> <para> <para>The type of resource for which you are configuring logging. Must be <code>THING_Group</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTV2LoggingLevelCmdlet.PassThru"> <summary> Returns the value passed to the TargetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTV2LoggingLevelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.RequestIOTCertificateTransferCmdlet"> <summary> Transfers the specified certificate to the specified AWS account. <para> You can cancel the transfer until it is acknowledged by the recipient. </para><para> No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target. </para><para> The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it. </para><para> The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RequestIOTCertificateTransferCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RequestIOTCertificateTransferCmdlet.TargetAwsAccount"> <summary> <para> <para>The AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RequestIOTCertificateTransferCmdlet.TransferMessage"> <summary> <para> <para>The transfer message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RequestIOTCertificateTransferCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.SearchIOTIndexCmdlet"> <summary> The query search index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SearchIOTIndexCmdlet.IndexName"> <summary> <para> <para>The search index name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SearchIOTIndexCmdlet.QueryString"> <summary> <para> <para>The search query string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SearchIOTIndexCmdlet.QueryVersion"> <summary> <para> <para>The query version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SearchIOTIndexCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SearchIOTIndexCmdlet.NextToken"> <summary> <para> <para>The token used to get the next set of results, or null if there are no additional results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SearchIOTIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultAuthorizerCmdlet"> <summary> Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultAuthorizerCmdlet.AuthorizerName"> <summary> <para> <para>The authorizer name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultAuthorizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultPolicyVersionCmdlet"> <summary> Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultPolicyVersionCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultPolicyVersionCmdlet.PolicyVersionId"> <summary> <para> <para>The policy version ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultPolicyVersionCmdlet.PassThru"> <summary> Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultPolicyVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.SetIOTLoggingOptionCmdlet"> <summary> Sets the logging options. <para> NOTE: use of this command is not recommended. Use <code>SetV2LoggingOptions</code> instead. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTLoggingOptionCmdlet.LoggingOptionsPayload_LogLevel"> <summary> <para> <para>The log level.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTLoggingOptionCmdlet.LoggingOptionsPayload_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTLoggingOptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.SetIOTThingTypeDeprecationCmdlet"> <summary> Deprecates a thing type. You can not associate new things with deprecated thing type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTThingTypeDeprecationCmdlet.ThingTypeName"> <summary> <para> <para>The name of the thing type to deprecate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTThingTypeDeprecationCmdlet.UndoDeprecate"> <summary> <para> <para>Whether to undeprecate a deprecated thing type. If <b>true</b>, the thing type will not be deprecated anymore and you can associate it with things.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTThingTypeDeprecationCmdlet.PassThru"> <summary> Returns the value passed to the ThingTypeName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTThingTypeDeprecationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet"> <summary> Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.TopicRulePayload_Action"> <summary> <para> <para>The actions associated with the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchAlarm_AlarmName"> <summary> <para> <para>The CloudWatch alarm name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.TopicRulePayload_AwsIotSqlVersion"> <summary> <para> <para>The version of the SQL rules engine to use when evaluating the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.S3_BucketName"> <summary> <para> <para>The Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.S3_CannedAcl"> <summary> <para> <para>The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl">S3 canned ACLs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.IotAnalytics_ChannelArn"> <summary> <para> <para>(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.IotAnalytics_ChannelName"> <summary> <para> <para>The name of the IoT Analytics channel to which message data will be sent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Firehose_DeliveryStreamName"> <summary> <para> <para>The delivery stream name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.TopicRulePayload_Description"> <summary> <para> <para>The description of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Elasticsearch_Endpoint"> <summary> <para> <para>The endpoint of your Elasticsearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.StepFunctions_ExecutionNamePrefix"> <summary> <para> <para>(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Lambda_FunctionArn"> <summary> <para> <para>The ARN of the Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_HashKeyField"> <summary> <para> <para>The hash key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_HashKeyType"> <summary> <para> <para>The hash key type. Valid values are "STRING" or "NUMBER"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_HashKeyValue"> <summary> <para> <para>The hash key value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Elasticsearch_Id"> <summary> <para> <para>The unique identifier for the document you are storing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Elasticsearch_Index"> <summary> <para> <para>The Elasticsearch index where you want to store your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.IotEvents_InputName"> <summary> <para> <para>The name of the AWS IoT Events input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.S3_Key"> <summary> <para> <para>The object key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Sns_MessageFormat"> <summary> <para> <para>(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see <a href="https://docs.aws.amazon.com/sns/latest/dg/json-formats.html">https://docs.aws.amazon.com/sns/latest/dg/json-formats.html</a> refer to their official documentation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.IotEvents_MessageId"> <summary> <para> <para>[Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchMetric_MetricName"> <summary> <para> <para>The CloudWatch metric name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchMetric_MetricNamespace"> <summary> <para> <para>The CloudWatch metric namespace name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchMetric_MetricTimestamp"> <summary> <para> <para>An optional <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp">Unix timestamp</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchMetric_MetricUnit"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit">metric unit</a> supported by CloudWatch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchMetric_MetricValue"> <summary> <para> <para>The CloudWatch metric value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_Operation"> <summary> <para> <para>The type of operation to be performed. This follows the substitution template, so it can be <code>${operation}</code>, but the substitution must result in one of the following: <code>INSERT</code>, <code>UPDATE</code>, or <code>DELETE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Kinesis_PartitionKey"> <summary> <para> <para>The partition key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_PayloadField"> <summary> <para> <para>The action payload. This name can be customized.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Republish_Qo"> <summary> <para> <para>The Quality of Service (QoS) level to use when republishing messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Sqs_QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_RangeKeyField"> <summary> <para> <para>The range key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_RangeKeyType"> <summary> <para> <para>The range key type. Valid values are "STRING" or "NUMBER"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_RangeKeyValue"> <summary> <para> <para>The range key value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchAlarm_RoleArn"> <summary> <para> <para>The IAM role that allows access to the CloudWatch alarm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchMetric_RoleArn"> <summary> <para> <para>The IAM role that allows access to the CloudWatch metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access to the DynamoDB table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDBv2_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access to the DynamoDB table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Elasticsearch_RoleArn"> <summary> <para> <para>The IAM role ARN that has access to Elasticsearch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Firehose_RoleArn"> <summary> <para> <para>The IAM role that grants access to the Amazon Kinesis Firehose stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.IotAnalytics_RoleArn"> <summary> <para> <para>The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.IotEvents_RoleArn"> <summary> <para> <para>The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Kinesis_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access to the Amazon Kinesis stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Republish_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.S3_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Sns_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Sqs_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.StepFunctions_RoleArn"> <summary> <para> <para>The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.TopicRulePayload_RuleDisabled"> <summary> <para> <para>Specifies whether the rule is disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Firehose_Separator"> <summary> <para> <para>A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.TopicRulePayload_Sql"> <summary> <para> <para>The SQL statement used to query the topic. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference">AWS IoT SQL Reference</a> in the <i>AWS IoT Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.StepFunctions_StateMachineName"> <summary> <para> <para>The name of the Step Functions state machine whose execution will be started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchAlarm_StateReason"> <summary> <para> <para>The reason for the alarm change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.CloudwatchAlarm_StateValue"> <summary> <para> <para>The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Kinesis_StreamName"> <summary> <para> <para>The name of the Amazon Kinesis stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.DynamoDB_TableName"> <summary> <para> <para>The name of the DynamoDB table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.PutItem_TableName"> <summary> <para> <para>The table where the message data will be written.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Sns_TargetArn"> <summary> <para> <para>The ARN of the SNS topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Salesforce_Token"> <summary> <para> <para>The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Republish_Topic"> <summary> <para> <para>The name of the MQTT topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Elasticsearch_Type"> <summary> <para> <para>The type of document you are storing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Salesforce_Url"> <summary> <para> <para>The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Sqs_UseBase64"> <summary> <para> <para>Specifies whether to use Base64 encoding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.PassThru"> <summary> Returns the value passed to the RuleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingLevelCmdlet"> <summary> Sets the logging level. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingLevelCmdlet.LogLevel"> <summary> <para> <para>The log level.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingLevelCmdlet.LogTarget_TargetName"> <summary> <para> <para>The target name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingLevelCmdlet.LogTarget_TargetType"> <summary> <para> <para>The target type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingLevelCmdlet.PassThru"> <summary> Returns the value passed to the LogLevel parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingLevelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingOptionCmdlet"> <summary> Sets the logging options for the V2 logging service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingOptionCmdlet.DefaultLogLevel"> <summary> <para> <para>The default logging level.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingOptionCmdlet.DisableAllLog"> <summary> <para> <para>If true all logs are disabled. The default is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingOptionCmdlet.RoleArn"> <summary> <para> <para>The ARN of the role that allows IoT to write to Cloudwatch logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTV2LoggingOptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.StartIOTAuditMitigationActionsTaskCmdlet"> <summary> Starts a task that applies a set of mitigation actions to the specified target. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTAuditMitigationActionsTaskCmdlet.AuditCheckToActionsMapping"> <summary> <para> <para>For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTAuditMitigationActionsTaskCmdlet.Target_AuditCheckToReasonCodeFilter"> <summary> <para> <para>Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTAuditMitigationActionsTaskCmdlet.Target_AuditTaskId"> <summary> <para> <para>If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTAuditMitigationActionsTaskCmdlet.ClientRequestToken"> <summary> <para> <para>Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTAuditMitigationActionsTaskCmdlet.Target_FindingId"> <summary> <para> <para>If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTAuditMitigationActionsTaskCmdlet.TaskId"> <summary> <para> <para>A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTAuditMitigationActionsTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.StartIOTOnDemandAuditTaskCmdlet"> <summary> Starts an on-demand Device Defender audit. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTOnDemandAuditTaskCmdlet.TargetCheckName"> <summary> <para> <para>Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTOnDemandAuditTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.StartIOTThingRegistrationTaskCmdlet"> <summary> Creates a bulk thing provisioning task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTThingRegistrationTaskCmdlet.InputFileBucket"> <summary> <para> <para>The S3 bucket that contains the input file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTThingRegistrationTaskCmdlet.InputFileKey"> <summary> <para> <para>The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTThingRegistrationTaskCmdlet.RoleArn"> <summary> <para> <para>The IAM role ARN that grants permission the input file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTThingRegistrationTaskCmdlet.TemplateBody"> <summary> <para> <para>The provisioning template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StartIOTThingRegistrationTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.StopIOTAuditMitigationActionsTaskCmdlet"> <summary> Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTAuditMitigationActionsTaskCmdlet.TaskId"> <summary> <para> <para>The unique identifier for the task that you want to cancel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTAuditMitigationActionsTaskCmdlet.PassThru"> <summary> Returns the value passed to the TaskId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTAuditMitigationActionsTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.StopIOTAuditTaskCmdlet"> <summary> Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTAuditTaskCmdlet.TaskId"> <summary> <para> <para>The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTAuditTaskCmdlet.PassThru"> <summary> Returns the value passed to the TaskId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTAuditTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.StopIOTCertificateTransferCmdlet"> <summary> Cancels a pending transfer for the specified certificate. <para><b>Note</b> Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use <a>RejectCertificateTransfer</a> instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. </para><para> After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTCertificateTransferCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTCertificateTransferCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTCertificateTransferCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobCmdlet"> <summary> Cancels a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobCmdlet.Comment"> <summary> <para> <para>An optional comment string describing why the job was canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobCmdlet.Enforce"> <summary> <para> <para>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</para><para>Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobCmdlet.JobId"> <summary> <para> <para>The unique identifier you assigned to this job when it was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobCmdlet.ReasonCode"> <summary> <para> <para>(Optional)A reason code string that explains why the job was canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobExecutionCmdlet"> <summary> Cancels the execution of a job for a given thing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobExecutionCmdlet.ExpectedVersion"> <summary> <para> <para>(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobExecutionCmdlet.Enforce"> <summary> <para> <para>(Optional) If <code>true</code> the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set <code>force</code> to <code>true</code>, then an <code>InvalidStateTransitionException</code> will be thrown. The default is <code>false</code>.</para><para>Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobExecutionCmdlet.JobId"> <summary> <para> <para>The ID of the job to be canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobExecutionCmdlet.StatusDetail"> <summary> <para> <para>A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobExecutionCmdlet.ThingName"> <summary> <para> <para>The name of the thing whose execution of the job will be canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobExecutionCmdlet.PassThru"> <summary> Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTJobExecutionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.StopIOTThingRegistrationTaskCmdlet"> <summary> Cancels a bulk thing provisioning task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTThingRegistrationTaskCmdlet.TaskId"> <summary> <para> <para>The bulk thing provisioning task ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTThingRegistrationTaskCmdlet.PassThru"> <summary> Returns the value passed to the TaskId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTThingRegistrationTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.TestIOTAuthorizationCmdlet"> <summary> Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTAuthorizationCmdlet.AuthInfo"> <summary> <para> <para>A list of authorization info objects. Simulating authorization will create a response for each <code>authInfo</code> object in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTAuthorizationCmdlet.ClientId"> <summary> <para> <para>The MQTT client ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTAuthorizationCmdlet.CognitoIdentityPoolId"> <summary> <para> <para>The Cognito identity pool ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTAuthorizationCmdlet.PolicyNamesToAdd"> <summary> <para> <para>When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTAuthorizationCmdlet.PolicyNamesToSkip"> <summary> <para> <para>When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTAuthorizationCmdlet.Principal"> <summary> <para> <para>The principal.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.TestIOTInvokeAuthorizerCmdlet"> <summary> Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTInvokeAuthorizerCmdlet.AuthorizerName"> <summary> <para> <para>The custom authorizer name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTInvokeAuthorizerCmdlet.Token"> <summary> <para> <para>The token returned by your custom authentication service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTInvokeAuthorizerCmdlet.TokenSignature"> <summary> <para> <para>The signature made with the token and your custom authentication service's private key.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.TestIOTValidSecurityProfileBehaviorCmdlet"> <summary> Validates a Device Defender security profile behaviors specification. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.TestIOTValidSecurityProfileBehaviorCmdlet.Behavior"> <summary> <para> <para>Specifies the behaviors that, when violated by a device (thing), cause an alert.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAccountAuditConfigurationCmdlet"> <summary> Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAccountAuditConfigurationCmdlet.AuditCheckConfiguration"> <summary> <para> <para>Specifies which audit checks are enabled and disabled for this account. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are currently enabled.</para><para>Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.</para><para>You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.</para><para>On the first call to <code>UpdateAccountAuditConfiguration</code>, this parameter is required and must specify at least one enabled check.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAccountAuditConfigurationCmdlet.AuditNotificationTargetConfiguration"> <summary> <para> <para>Information about the targets to which audit notifications are sent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAccountAuditConfigurationCmdlet.RoleArn"> <summary> <para> <para>The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAccountAuditConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the RoleArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAccountAuditConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAuthorizerCmdlet"> <summary> Updates an authorizer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAuthorizerCmdlet.AuthorizerFunctionArn"> <summary> <para> <para>The ARN of the authorizer's Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAuthorizerCmdlet.AuthorizerName"> <summary> <para> <para>The authorizer name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAuthorizerCmdlet.Status"> <summary> <para> <para>The status of the update authorizer request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAuthorizerCmdlet.TokenKeyName"> <summary> <para> <para>The key used to extract the token from the HTTP headers. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAuthorizerCmdlet.TokenSigningPublicKey"> <summary> <para> <para>The public keys used to verify the token signature.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTAuthorizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTBillingGroupCmdlet"> <summary> Updates information about the billing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTBillingGroupCmdlet.BillingGroupProperties_BillingGroupDescription"> <summary> <para> <para>The description of the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTBillingGroupCmdlet.BillingGroupName"> <summary> <para> <para>The name of the billing group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTBillingGroupCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the <code>UpdateBillingGroup</code> request is rejected with a <code>VersionConflictException</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTBillingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCACertificateCmdlet"> <summary> Updates a registered CA certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCACertificateCmdlet.CertificateId"> <summary> <para> <para>The CA certificate identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCACertificateCmdlet.NewAutoRegistrationStatus"> <summary> <para> <para>The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCACertificateCmdlet.NewStatus"> <summary> <para> <para>The updated status of the CA certificate.</para><para><b>Note:</b> The status value REGISTER_INACTIVE is deprecated and should not be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCACertificateCmdlet.RemoveAutoRegistration"> <summary> <para> <para>If true, removes auto registration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCACertificateCmdlet.RegistrationConfig_RoleArn"> <summary> <para> <para>The ARN of the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCACertificateCmdlet.RegistrationConfig_TemplateBody"> <summary> <para> <para>The template body.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCACertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCertificateCmdlet"> <summary> Updates the status of the specified certificate. This operation is idempotent. <para> Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect. </para><para> The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCertificateCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCertificateCmdlet.NewStatus"> <summary> <para> <para>The new status.</para><para><b>Note:</b> Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.</para><para><b>Note:</b> The status value REGISTER_INACTIVE is deprecated and should not be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCertificateCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTDynamicThingGroupCmdlet"> <summary> Updates a dynamic thing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTDynamicThingGroupCmdlet.ThingGroupProperties_AttributePayload"> <summary> <para> <para>The thing group attributes in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTDynamicThingGroupCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the dynamic thing group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTDynamicThingGroupCmdlet.IndexName"> <summary> <para> <para>The dynamic thing group index to update.</para><note><para>Currently one index is supported: 'AWS_Things'.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTDynamicThingGroupCmdlet.QueryString"> <summary> <para> <para>The dynamic thing group search query string to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTDynamicThingGroupCmdlet.QueryVersion"> <summary> <para> <para>The dynamic thing group query version to update.</para><note><para>Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTDynamicThingGroupCmdlet.ThingGroupProperties_ThingGroupDescription"> <summary> <para> <para>The thing group description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTDynamicThingGroupCmdlet.ThingGroupName"> <summary> <para> <para>The name of the dynamic thing group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTDynamicThingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTEventConfigurationCmdlet"> <summary> Updates the event configurations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTEventConfigurationCmdlet.EventConfiguration"> <summary> <para> <para>The new event configuration values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTEventConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the EventConfiguration parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTEventConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTIndexingConfigurationCmdlet"> <summary> Updates the search configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTIndexingConfigurationCmdlet.ThingIndexingConfiguration_ThingConnectivityIndexingMode"> <summary> <para> <para>Thing connectivity indexing mode. Valid values are: </para><ul><li><para>STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.</para></li><li><para>OFF - Thing connectivity status indexing is disabled.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTIndexingConfigurationCmdlet.ThingGroupIndexingConfiguration_ThingGroupIndexingMode"> <summary> <para> <para>Thing group indexing mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTIndexingConfigurationCmdlet.ThingIndexingConfiguration_ThingIndexingMode"> <summary> <para> <para>Thing indexing mode. Valid values are:</para><ul><li><para>REGISTRY – Your thing index contains registry data only.</para></li><li><para>REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.</para></li><li><para>OFF - Thing indexing is disabled.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTIndexingConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the ThingIndexingConfiguration_ThingIndexingMode parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTIndexingConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet"> <summary> Updates supported fields of the specified job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.AbortConfig_CriteriaList"> <summary> <para> <para>The list of abort criteria to define rules to abort the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.Description"> <summary> <para> <para>A short text description of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.PresignedUrlConfig_ExpiresInSec"> <summary> <para> <para>How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.JobExecutionsRolloutConfig_ExponentialRate"> <summary> <para> <para>The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.TimeoutConfig_InProgressTimeoutInMinute"> <summary> <para> <para>Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal <code>TIMED_OUT</code> status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.JobId"> <summary> <para> <para>The ID of the job to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.JobExecutionsRolloutConfig_MaximumPerMinute"> <summary> <para> <para>The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.PresignedUrlConfig_RoleArn"> <summary> <para> <para>The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.PassThru"> <summary> Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet"> <summary> Updates the definition for the specified mitigation action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.UpdateCACertificateParams_Action"> <summary> <para> <para>The action that you want to apply to the CA cerrtificate. The only supported value is <code>DEACTIVATE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.UpdateDeviceCertificateParams_Action"> <summary> <para> <para>The action that you want to apply to the device cerrtificate. The only supported value is <code>DEACTIVATE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.ActionName"> <summary> <para> <para>The friendly name for the mitigation action. You can't change the name by using <code>UpdateMitigationAction</code>. Instead, you must delete and re-create the mitigation action with the new name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.EnableIoTLoggingParams_LogLevel"> <summary> <para> <para>Specifies the types of information to be logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.AddThingsToThingGroupParams_OverrideDynamicGroup"> <summary> <para> <para>Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.RoleArn"> <summary> <para> <para>The ARN of the IAM role that is used to apply the mitigation action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.EnableIoTLoggingParams_RoleArnForLogging"> <summary> <para> <para>The ARN of the IAM role used for logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.ReplaceDefaultPolicyVersionParams_TemplateName"> <summary> <para> <para>The name of the template to be applied. The only supported value is <code>BLANK_POLICY</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.AddThingsToThingGroupParams_ThingGroupName"> <summary> <para> <para>The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.PublishFindingToSnsParams_TopicArn"> <summary> <para> <para>The ARN of the topic to which you want to publish the findings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTMitigationActionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTRoleAliasCmdlet"> <summary> Updates a role alias. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTRoleAliasCmdlet.CredentialDurationSecond"> <summary> <para> <para>The number of seconds the credential will be valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTRoleAliasCmdlet.RoleAlias"> <summary> <para> <para>The role alias to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTRoleAliasCmdlet.RoleArn"> <summary> <para> <para>The role ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTRoleAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTScheduledAuditCmdlet"> <summary> Updates a scheduled audit, including which checks are performed and how often the audit takes place. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTScheduledAuditCmdlet.DayOfMonth"> <summary> <para> <para>The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTScheduledAuditCmdlet.DayOfWeek"> <summary> <para> <para>The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTScheduledAuditCmdlet.Frequency"> <summary> <para> <para>How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTScheduledAuditCmdlet.ScheduledAuditName"> <summary> <para> <para>The name of the scheduled audit. (Max. 128 chars)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTScheduledAuditCmdlet.TargetCheckName"> <summary> <para> <para>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTScheduledAuditCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet"> <summary> Updates a Device Defender security profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.AdditionalMetricsToRetain"> <summary> <para> <para>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.AlertTarget"> <summary> <para> <para>Where the alerts are sent. (Alerts are always sent to the console.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.Behavior"> <summary> <para> <para>Specifies the behaviors that, when violated by a device (thing), cause an alert.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.DeleteAdditionalMetricsToRetain"> <summary> <para> <para>If true, delete all <code>additionalMetricsToRetain</code> defined for this security profile. If any <code>additionalMetricsToRetain</code> are defined in the current invocation, an exception occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.DeleteAlertTarget"> <summary> <para> <para>If true, delete all <code>alertTargets</code> defined for this security profile. If any <code>alertTargets</code> are defined in the current invocation, an exception occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.DeleteBehavior"> <summary> <para> <para>If true, delete all <code>behaviors</code> defined for this security profile. If any <code>behaviors</code> are defined in the current invocation, an exception occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a <code>VersionConflictException</code> is thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.SecurityProfileDescription"> <summary> <para> <para>A description of the security profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.SecurityProfileName"> <summary> <para> <para>The name of the security profile you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTSecurityProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTStreamCmdlet"> <summary> Updates an existing stream. The stream version will be incremented by one. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTStreamCmdlet.Description"> <summary> <para> <para>The description of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTStreamCmdlet.File"> <summary> <para> <para>The files associated with the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTStreamCmdlet.RoleArn"> <summary> <para> <para>An IAM role that allows the IoT service principal assumes to access your S3 files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTStreamCmdlet.StreamId"> <summary> <para> <para>The stream ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTStreamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet"> <summary> Updates the data for a thing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.AttributePayload"> <summary> <para> <para>A list of thing attributes, a JSON string containing name-value pairs. For example:</para><para><code>{\"attributes\":{\"name1\":\"value2\"}}</code></para><para>This data is used to add new attributes or update existing attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the <code>UpdateThing</code> request is rejected with a <code>VersionConflictException</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.RemoveThingType"> <summary> <para> <para>Remove a thing type association. If <b>true</b>, the association is removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.ThingName"> <summary> <para> <para>The name of the thing to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.ThingTypeName"> <summary> <para> <para>The name of the thing type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupCmdlet"> <summary> Update a thing group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupCmdlet.ThingGroupProperties_AttributePayload"> <summary> <para> <para>The thing group attributes in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupCmdlet.ExpectedVersion"> <summary> <para> <para>The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupCmdlet.ThingGroupProperties_ThingGroupDescription"> <summary> <para> <para>The thing group description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupCmdlet.ThingGroupName"> <summary> <para> <para>The thing group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupsForThingCmdlet"> <summary> Updates the groups to which the thing belongs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupsForThingCmdlet.OverrideDynamicGroup"> <summary> <para> <para>Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupsForThingCmdlet.ThingGroupsToAdd"> <summary> <para> <para>The groups to which the thing will be added.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupsForThingCmdlet.ThingGroupsToRemove"> <summary> <para> <para>The groups from which the thing will be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupsForThingCmdlet.ThingName"> <summary> <para> <para>The thing whose group memberships will be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupsForThingCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingGroupsForThingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |