AWS.Tools.SecurityIR.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SecurityIR</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.AddSecurityIRResourceTagCmdlet"> <summary> Adds a tag(s) to a designated resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.AddSecurityIRResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Required element for TagResource to identify the ARN for the resource to add a tag to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.AddSecurityIRResourceTagCmdlet.Tag"> <summary> <para> <para>Required element for ListTagsForResource to provide the content for a tag.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.AddSecurityIRResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.AddSecurityIRResourceTagCmdlet.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.SecurityIR.CloseSecurityIRCaseCmdlet"> <summary> Closes an existing case. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.CloseSecurityIRCaseCmdlet.CaseId"> <summary> <para> <para>Required element used in combination with CloseCase to identify the case ID to close.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.CloseSecurityIRCaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.CloseCaseResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.CloseCaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.CloseSecurityIRCaseCmdlet.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.SecurityIR.GetSecurityIRCaseCmdlet"> <summary> Returns the attributes of a case. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseCmdlet.CaseId"> <summary> <para> <para>Required element for GetCase to identify the requested case ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.GetCaseResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.GetCaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentDownloadUrlCmdlet"> <summary> Returns a Pre-Signed URL for uploading attachments into a case. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentDownloadUrlCmdlet.AttachmentId"> <summary> <para> <para>Required element for GetCaseAttachmentDownloadUrl to identify the attachment ID for downloading an attachment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentDownloadUrlCmdlet.CaseId"> <summary> <para> <para>Required element for GetCaseAttachmentDownloadUrl to identify the case ID for downloading an attachment from. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentDownloadUrlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttachmentPresignedUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.GetCaseAttachmentDownloadUrlResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.GetCaseAttachmentDownloadUrlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentUploadUrlCmdlet"> <summary> Uploads an attachment to a case. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentUploadUrlCmdlet.CaseId"> <summary> <para> <para>Required element for GetCaseAttachmentUploadUrl to identify the case ID for uploading an attachment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentUploadUrlCmdlet.ContentLength"> <summary> <para> <para>Required element for GetCaseAttachmentUploadUrl to identify the size of the file attachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentUploadUrlCmdlet.FileName"> <summary> <para> <para>Required element for GetCaseAttachmentUploadUrl to identify the file name of the attachment to upload. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentUploadUrlCmdlet.ClientToken"> <summary> <para> <para><note><para>The <c>clientToken</c> field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided. </para></note></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseAttachmentUploadUrlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttachmentPresignedUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.GetCaseAttachmentUploadUrlResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.GetCaseAttachmentUploadUrlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseEditListCmdlet"> <summary> Views the case history for edits made to a designated case.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseEditListCmdlet.CaseId"> <summary> <para> <para>Required element used with ListCaseEdits to identify the case to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseEditListCmdlet.MaxResult"> <summary> <para> <para>Optional element to identify how many results to obtain. There is a maximum value of 25.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseEditListCmdlet.NextToken"> <summary> <para> <para>An optional string that, if supplied, must be copied from the output of a previous call to ListCaseEdits. When provided in this manner, the API fetches the next page 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseEditListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.ListCaseEditsResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.ListCaseEditsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseEditListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseListCmdlet"> <summary> Lists all cases the requester has access to.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseListCmdlet.MaxResult"> <summary> <para> <para>Optional element for ListCases to limit the number of responses.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseListCmdlet.NextToken"> <summary> <para> <para>An optional string that, if supplied, must be copied from the output of a previous call to ListCases. When provided in this manner, the API fetches the next page 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.ListCasesResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.ListCasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCaseListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCommentListCmdlet"> <summary> Returns comments for a designated case.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCommentListCmdlet.CaseId"> <summary> <para> <para>Required element for ListComments to designate the case to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCommentListCmdlet.MaxResult"> <summary> <para> <para>Optional element for ListComments to limit the number of responses.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCommentListCmdlet.NextToken"> <summary> <para> <para>An optional string that, if supplied, must be copied from the output of a previous call to ListComments. When provided in this manner, the API fetches the next page 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCommentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.ListCommentsResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.ListCommentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRCommentListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRGetMemberAccountDetailCmdlet"> <summary> Provides information on whether the supplied account IDs are associated with a membership. <note><para> AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be <c>123123123</c> which is nine digits, and with zero-prepend would be <c>000123123123</c>. Not zero-prepending to 12 digits could result in errors. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRGetMemberAccountDetailCmdlet.AccountId"> <summary> <para> <para>Optional element to query the membership relationship status to a provided list of account IDs.</para><note><para> AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be <c>123123123</c> which is nine digits, and with zero-prepend would be <c>000123123123</c>. Not zero-prepending to 12 digits could result in errors. </para></note><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRGetMemberAccountDetailCmdlet.MembershipId"> <summary> <para> <para>Required element used in combination with BatchGetMemberAccountDetails to identify the membership ID to query. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRGetMemberAccountDetailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.BatchGetMemberAccountDetailsResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.BatchGetMemberAccountDetailsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRInvestigationListCmdlet"> <summary> Investigation performed by an agent for a security incident...<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRInvestigationListCmdlet.CaseId"> <summary> <para> <para>Investigation performed by an agent for a security incident per caseID</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRInvestigationListCmdlet.MaxResult"> <summary> <para> <para>Investigation performed by an agent for a security incident request, returning max results</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRInvestigationListCmdlet.NextToken"> <summary> <para> <para>Investigation performed by an agent for a security incident request</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRInvestigationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InvestigationActions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.ListInvestigationsResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.ListInvestigationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRInvestigationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRMembershipCmdlet"> <summary> Returns the attributes of a membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRMembershipCmdlet.MembershipId"> <summary> <para> <para>Required element for GetMembership to identify the membership ID to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.GetMembershipResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.GetMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRMembershipListCmdlet"> <summary> Returns the memberships that the calling principal can access.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRMembershipListCmdlet.MaxResult"> <summary> <para> <para>Request element for ListMemberships to limit the number of responses.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRMembershipListCmdlet.NextToken"> <summary> <para> <para>An optional string that, if supplied, must be copied from the output of a previous call to ListMemberships. When provided in this manner, the API fetches the next page 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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRMembershipListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.ListMembershipsResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.ListMembershipsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRMembershipListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRResourceTagCmdlet"> <summary> Returns currently configured tags on a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Required element for ListTagsForResource to provide the ARN to identify a specific resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.GetSecurityIRResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet"> <summary> Creates a new case. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.Description"> <summary> <para> <para>Required element used in combination with CreateCase</para><para>to provide a description for the new case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.EngagementType"> <summary> <para> <para>Required element used in combination with CreateCase to provide an engagement type for the new cases. Available engagement types include Security Incident | Investigation </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.ImpactedAccount"> <summary> <para> <para>Required element used in combination with CreateCase to provide a list of impacted accounts.</para><note><para> AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be <c>123123123</c> which is nine digits, and with zero-prepend would be <c>000123123123</c>. Not zero-prepending to 12 digits could result in errors. </para></note><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.ImpactedAwsRegion"> <summary> <para> <para>An optional element used in combination with CreateCase to provide a list of impacted regions.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.ImpactedService"> <summary> <para> <para>An optional element used in combination with CreateCase to provide a list of services impacted.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.ReportedIncidentStartDate"> <summary> <para> <para>Required element used in combination with CreateCase to provide an initial start date for the unauthorized activity. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.ResolverType"> <summary> <para> <para>Required element used in combination with CreateCase to identify the resolver type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.Tag"> <summary> <para> <para>An optional element used in combination with CreateCase to add customer specified tags to a case.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.ThreatActorIpAddress"> <summary> <para> <para>An optional element used in combination with CreateCase to provide a list of suspicious internet protocol addresses associated with unauthorized activity. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.Title"> <summary> <para> <para>Required element used in combination with CreateCase to provide a title for the new case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.Watcher"> <summary> <para> <para>Required element used in combination with CreateCase to provide a list of entities to receive notifications for case updates. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.ClientToken"> <summary> <para> <para><note><para>The <c>clientToken</c> field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided. </para></note></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CaseId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.CreateCaseResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.CreateCaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCmdlet.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.SecurityIR.NewSecurityIRCaseCommentCmdlet"> <summary> Adds a comment to an existing case. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCommentCmdlet.Body"> <summary> <para> <para>Required element used in combination with CreateCaseComment to add content for the new comment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCommentCmdlet.CaseId"> <summary> <para> <para>Required element used in combination with CreateCaseComment to specify a case ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCommentCmdlet.ClientToken"> <summary> <para> <para><note><para>The <c>clientToken</c> field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided. </para></note></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCommentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CommentId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.CreateCaseCommentResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.CreateCaseCommentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRCaseCommentCmdlet.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.SecurityIR.NewSecurityIRMembershipCmdlet"> <summary> Creates a new membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRMembershipCmdlet.CoverEntireOrganization"> <summary> <para> <para>The <c>coverEntireOrganization</c> parameter is a boolean flag that determines whether the membership should be applied to the entire Amazon Web Services Organization. When set to true, the membership will be created for all accounts within the organization. When set to false, the membership will only be created for specified accounts. </para><para>This parameter is optional. If not specified, the default value is false.</para><ul><li><para>If set to <i>true</i>: The membership will automatically include all existing and future accounts in the Amazon Web Services Organization. </para></li><li><para>If set to <i>false</i>: The membership will only apply to explicitly specified accounts. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRMembershipCmdlet.IncidentResponseTeam"> <summary> <para> <para>Required element used in combination with CreateMembership to add customer incident response team members and trusted partners to the membership. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRMembershipCmdlet.MembershipName"> <summary> <para> <para>Required element used in combination with CreateMembership to create a name for the membership.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRMembershipCmdlet.OptInFeature"> <summary> <para> <para>Optional element to enable the monitoring and investigation opt-in features for the service.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRMembershipCmdlet.Tag"> <summary> <para> <para>Optional element for customer configured tags.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRMembershipCmdlet.ClientToken"> <summary> <para> <para><note><para>The <c>clientToken</c> field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided. </para></note></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MembershipId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.CreateMembershipResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.CreateMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.NewSecurityIRMembershipCmdlet.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.SecurityIR.RemoveSecurityIRResourceTagCmdlet"> <summary> Removes a tag(s) from a designate resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.RemoveSecurityIRResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Required element for UnTagResource to identify the ARN for the resource to remove a tag from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.RemoveSecurityIRResourceTagCmdlet.TagKey"> <summary> <para> <para>Required element for UnTagResource to identify tag to remove.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.RemoveSecurityIRResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.RemoveSecurityIRResourceTagCmdlet.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.SecurityIR.SendSecurityIRFeedbackCmdlet"> <summary> Send feedback based on response investigation action </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.SendSecurityIRFeedbackCmdlet.CaseId"> <summary> <para> <para>Send feedback based on request caseID</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.SendSecurityIRFeedbackCmdlet.Comment"> <summary> <para> <para>Send feedback based on request comments</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.SendSecurityIRFeedbackCmdlet.ResultId"> <summary> <para> <para>Send feedback based on request result ID</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.SendSecurityIRFeedbackCmdlet.Usefulness"> <summary> <para> <para>Required enum value indicating user assessment of result q.....</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.SendSecurityIRFeedbackCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.SendFeedbackResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.SendSecurityIRFeedbackCmdlet.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.SecurityIR.StopSecurityIRMembershipCmdlet"> <summary> Cancels an existing membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.StopSecurityIRMembershipCmdlet.MembershipId"> <summary> <para> <para>Required element used in combination with CancelMembershipRequest to identify the membership ID to cancel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.StopSecurityIRMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MembershipId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.CancelMembershipResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.CancelMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.StopSecurityIRMembershipCmdlet.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.SecurityIR.UpdateSecurityIRCaseCmdlet"> <summary> Updates an existing case. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ActualIncidentStartDate"> <summary> <para> <para>Optional element for UpdateCase to provide content for the incident start date field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.CaseId"> <summary> <para> <para>Required element for UpdateCase to identify the case ID for updates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.CaseMetadata"> <summary> <para> <para>Update the case request with case metadata</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.Description"> <summary> <para> <para>Optional element for UpdateCase to provide content for the description field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.EngagementType"> <summary> <para> <para>Optional element for UpdateCase to provide content for the engagement type field. <c>Available engagement types include Security Incident | Investigation</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ImpactedAccountsToAdd"> <summary> <para> <para>Optional element for UpdateCase to provide content to add accounts impacted.</para><note><para> AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be <c>123123123</c> which is nine digits, and with zero-prepend would be <c>000123123123</c>. Not zero-prepending to 12 digits could result in errors. </para></note><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ImpactedAccountsToDelete"> <summary> <para> <para>Optional element for UpdateCase to provide content to add accounts impacted.</para><note><para> AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be <c>123123123</c> which is nine digits, and with zero-prepend would be <c>000123123123</c>. Not zero-prepending to 12 digits could result in errors. </para></note><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ImpactedAwsRegionsToAdd"> <summary> <para> <para>Optional element for UpdateCase to provide content to add regions impacted.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ImpactedAwsRegionsToDelete"> <summary> <para> <para>Optional element for UpdateCase to provide content to remove regions impacted.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ImpactedServicesToAdd"> <summary> <para> <para>Optional element for UpdateCase to provide content to add services impacted.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ImpactedServicesToDelete"> <summary> <para> <para>Optional element for UpdateCase to provide content to remove services impacted.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ReportedIncidentStartDate"> <summary> <para> <para>Optional element for UpdateCase to provide content for the customer reported incident start date field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ThreatActorIpAddressesToAdd"> <summary> <para> <para>Optional element for UpdateCase to provide content to add additional suspicious IP addresses related to a case. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.ThreatActorIpAddressesToDelete"> <summary> <para> <para>Optional element for UpdateCase to provide content to remove suspicious IP addresses from a case.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.Title"> <summary> <para> <para>Optional element for UpdateCase to provide content for the title field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.WatchersToAdd"> <summary> <para> <para>Optional element for UpdateCase to provide content to add additional watchers to a case.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.WatchersToDelete"> <summary> <para> <para>Optional element for UpdateCase to provide content to remove existing watchers from a case.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.UpdateCaseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCmdlet.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.SecurityIR.UpdateSecurityIRCaseCommentCmdlet"> <summary> Updates an existing case comment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCommentCmdlet.Body"> <summary> <para> <para>Required element for UpdateCaseComment to identify the content for the comment to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCommentCmdlet.CaseId"> <summary> <para> <para>Required element for UpdateCaseComment to identify the case ID containing the comment to be updated. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCommentCmdlet.CommentId"> <summary> <para> <para>Required element for UpdateCaseComment to identify the case ID to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCommentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.UpdateCaseCommentResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.UpdateCaseCommentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseCommentCmdlet.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.SecurityIR.UpdateSecurityIRCaseStatusCmdlet"> <summary> Updates the state transitions for a designated cases. <para><b>Self-managed</b>: the following states are available for self-managed cases. </para><ul><li><para> Submitted → Detection and Analysis </para></li><li><para> Detection and Analysis → Containment, Eradication, and Recovery </para></li><li><para> Detection and Analysis → Post-incident Activities </para></li><li><para> Containment, Eradication, and Recovery → Detection and Analysis </para></li><li><para> Containment, Eradication, and Recovery → Post-incident Activities </para></li><li><para> Post-incident Activities → Containment, Eradication, and Recovery </para></li><li><para> Post-incident Activities → Detection and Analysis </para></li><li><para> Any → Closed </para></li></ul><para><b>AWS supported</b>: You must use the <c>CloseCase</c> API to close. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseStatusCmdlet.CaseId"> <summary> <para> <para>Required element for UpdateCaseStatus to identify the case to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseStatusCmdlet.CaseStatus"> <summary> <para> <para>Required element for UpdateCaseStatus to identify the status for a case. Options include <c>Submitted | Detection and Analysis | Containment, Eradication and Recovery | Post-incident Activities</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CaseStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.UpdateCaseStatusResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.UpdateCaseStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRCaseStatusCmdlet.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.SecurityIR.UpdateSecurityIRMembershipCmdlet"> <summary> Updates membership configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.MembershipAccountsConfigurationsUpdate_CoverEntireOrganization"> <summary> <para> <para>The <c>coverEntireOrganization</c> field is a boolean value that determines whether the membership configuration should be applied across the entire Amazon Web Services Organization. </para><para>When set to <c>true</c>, the configuration will be applied to all accounts within the organization. When set to <c>false</c>, the configuration will only apply to specifically designated accounts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.IncidentResponseTeam"> <summary> <para> <para>Optional element for UpdateMembership to update the membership name.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.MembershipId"> <summary> <para> <para>Required element for UpdateMembership to identify the membership to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.MembershipName"> <summary> <para> <para>Optional element for UpdateMembership to update the membership name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.OptInFeature"> <summary> <para> <para>Optional element for UpdateMembership to enable or disable opt-in features for the service.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.MembershipAccountsConfigurationsUpdate_OrganizationalUnitsToAdd"> <summary> <para> <para>A list of organizational unit IDs to add to the membership configuration. Each organizational unit ID must match the pattern <c>ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}</c>. </para><para>The list must contain between 1 and 5 organizational unit IDs.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.MembershipAccountsConfigurationsUpdate_OrganizationalUnitsToRemove"> <summary> <para> <para>A list of organizational unit IDs to remove from the membership configuration. Each organizational unit ID must match the pattern <c>ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}</c>. </para><para>The list must contain between 1 and 5 organizational unit IDs per invocation of the API request.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.UndoMembershipCancellation"> <summary> <para> <para>The <c>undoMembershipCancellation</c> parameter is a boolean flag that indicates whether to reverse a previously requested membership cancellation. When set to true, this will revoke the cancellation request and maintain the membership status. </para><para>This parameter is optional and can be used in scenarios where you need to restore a membership that was marked for cancellation but hasn't been fully terminated yet. </para><ul><li><para>If set to <c>true</c>, the cancellation request will be revoked </para></li><li><para>If set to <c>false</c> the service will throw a ValidationException. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.UpdateMembershipResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRMembershipCmdlet.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.SecurityIR.UpdateSecurityIRResolverTypeCmdlet"> <summary> Updates the resolver type for a case. <important><para> This is a one-way action and cannot be reversed. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRResolverTypeCmdlet.CaseId"> <summary> <para> <para>Required element for UpdateResolverType to identify the case to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRResolverTypeCmdlet.ResolverType"> <summary> <para> <para>Required element for UpdateResolverType to identify the new resolver.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRResolverTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityIR.Model.UpdateResolverTypeResponse). Specifying the name of a property of type Amazon.SecurityIR.Model.UpdateResolverTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SecurityIR.UpdateSecurityIRResolverTypeCmdlet.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> |