AWS.Tools.Detective.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Detective</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.DTCT.ApproveDTCTInvitationCmdlet"> <summary> Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account. <para> The request provides the ARN of behavior graph. </para><para> The member account status in the graph must be <code>INVITED</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.ApproveDTCTInvitationCmdlet.GraphArn"> <summary> <para> <para>The ARN of the behavior graph that the member account is accepting the invitation for.</para><para>The member account status in the behavior graph must be <code>INVITED</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.ApproveDTCTInvitationCmdlet.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.Detective.Model.AcceptInvitationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.ApproveDTCTInvitationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GraphArn parameter. The -PassThru parameter is deprecated, use -Select '^GraphArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.ApproveDTCTInvitationCmdlet.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.DTCT.DenyDTCTInvitationCmdlet"> <summary> Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by a member account that has the <code>INVITED</code> status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.DenyDTCTInvitationCmdlet.GraphArn"> <summary> <para> <para>The ARN of the behavior graph to reject the invitation to.</para><para>The member account's current member status in the behavior graph must be <code>INVITED</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.DenyDTCTInvitationCmdlet.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.Detective.Model.RejectInvitationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.DenyDTCTInvitationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GraphArn parameter. The -PassThru parameter is deprecated, use -Select '^GraphArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.DenyDTCTInvitationCmdlet.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.DTCT.GetDTCTGraphListCmdlet"> <summary> Returns the list of behavior graphs that the calling account is a master of. This operation can only be called by a master account. <para> Because an account can currently only be the master of one behavior graph within a Region, the results always contain a single graph. </para><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.DTCT.GetDTCTGraphListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTGraphListCmdlet.NextToken"> <summary> <para> <para>For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTGraphListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GraphList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Detective.Model.ListGraphsResponse). Specifying the name of a property of type Amazon.Detective.Model.ListGraphsResponse 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.DTCT.GetDTCTGraphListCmdlet.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.DTCT.GetDTCTInvitationListCmdlet"> <summary> Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a member account. <para> Open invitations are invitations that the member account has not responded to. </para><para> The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from. </para><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.DTCT.GetDTCTInvitationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTInvitationListCmdlet.NextToken"> <summary> <para> <para>For requests to retrieve the next page of results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTInvitationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Invitations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Detective.Model.ListInvitationsResponse). Specifying the name of a property of type Amazon.Detective.Model.ListInvitationsResponse 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.DTCT.GetDTCTInvitationListCmdlet.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.DTCT.GetDTCTMemberCmdlet"> <summary> Returns the membership details for specified member accounts for a behavior graph. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTMemberCmdlet.AccountId"> <summary> <para> <para>The list of AWS account identifiers for the member account for which to return member details.</para><para>You cannot use <code>GetMembers</code> to retrieve information about member accounts that were removed from the behavior graph.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTMemberCmdlet.GraphArn"> <summary> <para> <para>The ARN of the behavior graph for which to request the member details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTMemberCmdlet.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.Detective.Model.GetMembersResponse). Specifying the name of a property of type Amazon.Detective.Model.GetMembersResponse 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.DTCT.GetDTCTMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GraphArn parameter. The -PassThru parameter is deprecated, use -Select '^GraphArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTMemberListCmdlet"> <summary> Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.<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.DTCT.GetDTCTMemberListCmdlet.GraphArn"> <summary> <para> <para>The ARN of the behavior graph for which to retrieve the list of member accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTMemberListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTMemberListCmdlet.NextToken"> <summary> <para> <para>For requests to retrieve the next page of member account results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTMemberListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MemberDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Detective.Model.ListMembersResponse). Specifying the name of a property of type Amazon.Detective.Model.ListMembersResponse 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.DTCT.GetDTCTMemberListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GraphArn parameter. The -PassThru parameter is deprecated, use -Select '^GraphArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.GetDTCTMemberListCmdlet.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.DTCT.NewDTCTGraphCmdlet"> <summary> Creates a new behavior graph for the calling account, and sets that account as the master account. This operation is called by the account that is enabling Detective. <para> Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective. </para><para> The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph. </para><para><code>CreateGraph</code> triggers a process to create the corresponding data tables for the new behavior graph. </para><para> An account can only be the master account for one behavior graph within a Region. If the same account calls <code>CreateGraph</code> with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.NewDTCTGraphCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GraphArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Detective.Model.CreateGraphResponse). Specifying the name of a property of type Amazon.Detective.Model.CreateGraphResponse 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.DTCT.NewDTCTGraphCmdlet.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.DTCT.NewDTCTMemberCmdlet"> <summary> Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the master account for a behavior graph. <para><code>CreateMembers</code> verifies the accounts and then sends invitations to the verified accounts. </para><para> The request provides the behavior graph ARN and the list of accounts to invite. </para><para> The response separates the requested accounts into two lists: </para><ul><li><para> The accounts that <code>CreateMembers</code> was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are being sent an invitation, and that have failed verification. </para></li><li><para> The accounts that <code>CreateMembers</code> was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.NewDTCTMemberCmdlet.Account"> <summary> <para> <para>The list of AWS accounts to invite to become member accounts in the behavior graph. For each invited account, the account list contains the account identifier and the AWS account root user email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.NewDTCTMemberCmdlet.GraphArn"> <summary> <para> <para>The ARN of the behavior graph to invite the member accounts to contribute their data to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.NewDTCTMemberCmdlet.Message"> <summary> <para> <para>Customized message text to include in the invitation email message to the invited member accounts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.NewDTCTMemberCmdlet.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.Detective.Model.CreateMembersResponse). Specifying the name of a property of type Amazon.Detective.Model.CreateMembersResponse 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.DTCT.NewDTCTMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GraphArn parameter. The -PassThru parameter is deprecated, use -Select '^GraphArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.NewDTCTMemberCmdlet.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.DTCT.RemoveDTCTGraphCmdlet"> <summary> Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs. <para><code>DeleteGraph</code> can only be called by the master account for a behavior graph. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTGraphCmdlet.GraphArn"> <summary> <para> <para>The ARN of the behavior graph to disable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTGraphCmdlet.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.Detective.Model.DeleteGraphResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTGraphCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GraphArn parameter. The -PassThru parameter is deprecated, use -Select '^GraphArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTGraphCmdlet.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.DTCT.RemoveDTCTMemberCmdlet"> <summary> Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use <code>DeleteMembers</code> to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the <code>DeleteGraph</code> API method. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTMemberCmdlet.AccountId"> <summary> <para> <para>The list of AWS account identifiers for the member accounts to delete from the behavior graph.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTMemberCmdlet.GraphArn"> <summary> <para> <para>The ARN of the behavior graph to delete members from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTMemberCmdlet.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.Detective.Model.DeleteMembersResponse). Specifying the name of a property of type Amazon.Detective.Model.DeleteMembersResponse 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.DTCT.RemoveDTCTMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GraphArn parameter. The -PassThru parameter is deprecated, use -Select '^GraphArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTMemberCmdlet.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.DTCT.RemoveDTCTMembershipCmdlet"> <summary> Removes the member account from the specified behavior graph. This operation can only be called by a member account that has the <code>ENABLED</code> status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTMembershipCmdlet.GraphArn"> <summary> <para> <para>The ARN of the behavior graph to remove the member account from.</para><para>The member account's member status in the behavior graph must be <code>ENABLED</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTMembershipCmdlet.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.Detective.Model.DisassociateMembershipResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GraphArn parameter. The -PassThru parameter is deprecated, use -Select '^GraphArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.RemoveDTCTMembershipCmdlet.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.DTCT.StartDTCTMonitoringMemberCmdlet"> <summary> Sends a request to enable data ingest for a member account that has a status of <code>ACCEPTED_BUT_DISABLED</code>. <para> For valid member accounts, the status is updated as follows. </para><ul><li><para> If Detective enabled the member account, then the new status is <code>ENABLED</code>. </para></li><li><para> If Detective cannot enable the member account, the status remains <code>ACCEPTED_BUT_DISABLED</code>. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.StartDTCTMonitoringMemberCmdlet.AccountId"> <summary> <para> <para>The account ID of the member account to try to enable.</para><para>The account must be an invited member account with a status of <code>ACCEPTED_BUT_DISABLED</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.StartDTCTMonitoringMemberCmdlet.GraphArn"> <summary> <para> <para>The ARN of the behavior graph.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.StartDTCTMonitoringMemberCmdlet.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.Detective.Model.StartMonitoringMemberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.StartDTCTMonitoringMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GraphArn parameter. The -PassThru parameter is deprecated, use -Select '^GraphArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DTCT.StartDTCTMonitoringMemberCmdlet.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> |