AWS.Tools.BackupSearch.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.BackupSearch</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.BAKS.AddBAKSResourceTagCmdlet"> <summary> This operation puts tags on the resource you indicate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.AddBAKSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the resource.</para><para>This is the resource that will have the indicated tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.AddBAKSResourceTagCmdlet.Tag"> <summary> <para> <para>Required tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.AddBAKSResourceTagCmdlet.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.BackupSearch.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.AddBAKSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.AddBAKSResourceTagCmdlet.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.BAKS.GetBAKSResourceTagCmdlet"> <summary> This operation returns the tags for a resource type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the resource.></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSResourceTagCmdlet.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.BackupSearch.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.BackupSearch.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="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobCmdlet"> <summary> This operation retrieves metadata of a search job, including its progress. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobCmdlet.SearchJobIdentifier"> <summary> <para> <para>Required unique string that specifies the search job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobCmdlet.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.BackupSearch.Model.GetSearchJobResponse). Specifying the name of a property of type Amazon.BackupSearch.Model.GetSearchJobResponse 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.BAKS.GetBAKSSearchJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SearchJobIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^SearchJobIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobBackupListCmdlet"> <summary> This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job. <para> If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a <c>FAILED</c> status from a permissions issue will be displayed, along with a status message. </para><para> Only recovery points with a backup index that has a status of <c>ACTIVE</c> will be included in search results. If the index has any other status, its status will be displayed along with a status message. </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.BAKS.GetBAKSSearchJobBackupListCmdlet.SearchJobIdentifier"> <summary> <para> <para>The unique string that specifies the search job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobBackupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of resource list items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobBackupListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned backups included in a search job.</para><para>For example, if a request is made to return <c>MaxResults</c> number of backups, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next 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/>'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.BAKS.GetBAKSSearchJobBackupListCmdlet.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.BackupSearch.Model.ListSearchJobBackupsResponse). Specifying the name of a property of type Amazon.BackupSearch.Model.ListSearchJobBackupsResponse 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.BAKS.GetBAKSSearchJobBackupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SearchJobIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^SearchJobIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobBackupListCmdlet.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.BAKS.GetBAKSSearchJobListCmdlet"> <summary> This operation returns a list of search jobs belonging to an account.<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.BAKS.GetBAKSSearchJobListCmdlet.ByStatus"> <summary> <para> <para>Include this parameter to filter list by search job status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of resource list items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned search jobs.</para><para>For example, if a request is made to return <c>MaxResults</c> number of backups, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next 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/>'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.BAKS.GetBAKSSearchJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SearchJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupSearch.Model.ListSearchJobsResponse). Specifying the name of a property of type Amazon.BackupSearch.Model.ListSearchJobsResponse 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.BAKS.GetBAKSSearchJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ByStatus parameter. The -PassThru parameter is deprecated, use -Select '^ByStatus' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobListCmdlet.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.BAKS.GetBAKSSearchJobResultListCmdlet"> <summary> This operation returns a list of a specified search job.<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.BAKS.GetBAKSSearchJobResultListCmdlet.SearchJobIdentifier"> <summary> <para> <para>The unique string that specifies the search job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobResultListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of resource list items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobResultListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned search job results.</para><para>For example, if a request is made to return <c>MaxResults</c> number of search job results, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next 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/>'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.BAKS.GetBAKSSearchJobResultListCmdlet.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.BackupSearch.Model.ListSearchJobResultsResponse). Specifying the name of a property of type Amazon.BackupSearch.Model.ListSearchJobResultsResponse 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.BAKS.GetBAKSSearchJobResultListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SearchJobIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^SearchJobIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchJobResultListCmdlet.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.BAKS.GetBAKSSearchResultExportJobCmdlet"> <summary> This operation retrieves the metadata of an export job. <para> An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file. </para><para> An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchResultExportJobCmdlet.ExportJobIdentifier"> <summary> <para> <para>This is the unique string that identifies a specific export job.</para><para>Required for this operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchResultExportJobCmdlet.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.BackupSearch.Model.GetSearchResultExportJobResponse). Specifying the name of a property of type Amazon.BackupSearch.Model.GetSearchResultExportJobResponse 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.BAKS.GetBAKSSearchResultExportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExportJobIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^ExportJobIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchResultExportJobListCmdlet"> <summary> This operation exports search results of a search job to a specified destination S3 bucket.<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.BAKS.GetBAKSSearchResultExportJobListCmdlet.SearchJobIdentifier"> <summary> <para> <para>The unique string that specifies the search job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchResultExportJobListCmdlet.Status"> <summary> <para> <para>The search jobs to be included in the export job can be filtered by including this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchResultExportJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of resource list items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchResultExportJobListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned backups included in a search job.</para><para>For example, if a request is made to return <c>MaxResults</c> number of backups, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next 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/>'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.BAKS.GetBAKSSearchResultExportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupSearch.Model.ListSearchResultExportJobsResponse). Specifying the name of a property of type Amazon.BackupSearch.Model.ListSearchResultExportJobsResponse 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.BAKS.GetBAKSSearchResultExportJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SearchJobIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^SearchJobIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.GetBAKSSearchResultExportJobListCmdlet.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.BAKS.RemoveBAKSResourceTagCmdlet"> <summary> This operation removes tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.RemoveBAKSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the resource where you want to remove tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.RemoveBAKSResourceTagCmdlet.TagKey"> <summary> <para> <para>This required parameter contains the tag keys you want to remove from the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.RemoveBAKSResourceTagCmdlet.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.BackupSearch.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.RemoveBAKSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.RemoveBAKSResourceTagCmdlet.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.BAKS.StartBAKSSearchJobCmdlet"> <summary> This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters. <para> You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.SearchScope_BackupResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the backup resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.SearchScope_BackupResourceTag"> <summary> <para> <para>These are one or more tags on the backup (recovery point).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.SearchScope_BackupResourceType"> <summary> <para> <para>The resource types included in a search.</para><para>Eligible resource types include S3 and EBS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.BackupResourceCreationTime_CreatedAfter"> <summary> <para> <para>This timestamp includes recovery points only created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.BackupResourceCreationTime_CreatedBefore"> <summary> <para> <para>This timestamp includes recovery points only created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.ItemFilters_EBSItemFilter"> <summary> <para> <para>This array can contain CreationTimes, FilePaths, LastModificationTimes, or Sizes objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.EncryptionKeyArn"> <summary> <para> <para>The encryption key for the specified search job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.Name"> <summary> <para> <para>Include alphanumeric characters to create a name for this search job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.ItemFilters_S3ItemFilter"> <summary> <para> <para>This array can contain CreationTimes, ETags, ObjectKeys, Sizes, or VersionIds objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.SearchScope_SourceResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that uniquely identifies the source resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.Tag"> <summary> <para> <para>List of tags returned by the operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.ClientToken"> <summary> <para> <para>Include this parameter to allow multiple identical calls for idempotency.</para><para>A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.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.BackupSearch.Model.StartSearchJobResponse). Specifying the name of a property of type Amazon.BackupSearch.Model.StartSearchJobResponse 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.BAKS.StartBAKSSearchJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchJobCmdlet.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.BAKS.StartBAKSSearchResultExportJobCmdlet"> <summary> This operations starts a job to export the results of search job to a designated S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchResultExportJobCmdlet.S3ExportSpecification_DestinationBucket"> <summary> <para> <para>This specifies the destination Amazon S3 bucket for the export job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchResultExportJobCmdlet.S3ExportSpecification_DestinationPrefix"> <summary> <para> <para>This specifies the prefix for the destination Amazon S3 bucket for the export job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchResultExportJobCmdlet.RoleArn"> <summary> <para> <para>This parameter specifies the role ARN used to start the search results export jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchResultExportJobCmdlet.SearchJobIdentifier"> <summary> <para> <para>The unique string that specifies the search job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchResultExportJobCmdlet.Tag"> <summary> <para> <para>Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchResultExportJobCmdlet.ClientToken"> <summary> <para> <para>Include this parameter to allow multiple identical calls for idempotency.</para><para>A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchResultExportJobCmdlet.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.BackupSearch.Model.StartSearchResultExportJobResponse). Specifying the name of a property of type Amazon.BackupSearch.Model.StartSearchResultExportJobResponse 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.BAKS.StartBAKSSearchResultExportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SearchJobIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^SearchJobIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StartBAKSSearchResultExportJobCmdlet.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.BAKS.StopBAKSSearchJobCmdlet"> <summary> This operations ends a search job. <para> Only a search job with a status of <c>RUNNING</c> can be stopped. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StopBAKSSearchJobCmdlet.SearchJobIdentifier"> <summary> <para> <para>The unique string that specifies the search job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StopBAKSSearchJobCmdlet.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.BackupSearch.Model.StopSearchJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StopBAKSSearchJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SearchJobIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^SearchJobIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAKS.StopBAKSSearchJobCmdlet.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> |