Container for the parameters to the DescribePipelines operation.

Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read permission for.

To retrieve the full pipeline definition instead of metadata about the pipeline, call the GetPipelineDefinition action.

Inheritance: Amazon.Runtime.AmazonWebServiceRequest
コード例 #1
0
        public object Execute(ExecutorContext context)
        {
            var cmdletContext = context as CmdletContext;
            // create request
            var request = new Amazon.DataPipeline.Model.DescribePipelinesRequest();

            if (cmdletContext.PipelineId != null)
            {
                request.PipelineIds = cmdletContext.PipelineId;
            }

            CmdletOutput output;

            // issue call
            var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);

            try
            {
                var    response       = CallAWSServiceOperation(client, request);
                object pipelineOutput = null;
                pipelineOutput = cmdletContext.Select(response, this);
                output         = new CmdletOutput
                {
                    PipelineOutput  = pipelineOutput,
                    ServiceResponse = response
                };
            }
            catch (Exception e)
            {
                output = new CmdletOutput {
                    ErrorResponse = e
                };
            }

            return(output);
        }
コード例 #2
0
        /// <summary>
        /// Initiates the asynchronous execution of the DescribePipelines operation.
        /// <seealso cref="Amazon.DataPipeline.IAmazonDataPipeline.DescribePipelines"/>
        /// </summary>
        /// 
        /// <param name="request">Container for the necessary parameters to execute the DescribePipelines operation.</param>
        /// <param name="cancellationToken">
        ///     A cancellation token that can be used by other objects or threads to receive notice of cancellation.
        /// </param>
        /// <returns>The task object representing the asynchronous operation.</returns>
		public Task<DescribePipelinesResponse> DescribePipelinesAsync(DescribePipelinesRequest request, CancellationToken cancellationToken = default(CancellationToken))
        {
            var marshaller = new DescribePipelinesRequestMarshaller();
            var unmarshaller = DescribePipelinesResponseUnmarshaller.GetInstance();
            return Invoke<IRequest, DescribePipelinesRequest, DescribePipelinesResponse>(request, marshaller, unmarshaller, signer, cancellationToken);
        }
コード例 #3
0
        /// <summary>
        /// <para> Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier,
        /// its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that
        /// you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read
        /// permission for. </para> <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call the
        /// GetPipelineDefinition action. </para>
        /// </summary>
        /// 
        /// <param name="request">Container for the necessary parameters to execute the DescribePipelines service method on
        /// AmazonDataPipeline.</param>
        /// 
        /// <returns>The response from the DescribePipelines service method, as returned by AmazonDataPipeline.</returns>
        /// 
        /// <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException" />
        /// <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException" />
        /// <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException" />
        /// <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException" />
		public DescribePipelinesResponse DescribePipelines(DescribePipelinesRequest request)
        {
            var task = DescribePipelinesAsync(request);
            try
            {
                return task.Result;
            }
            catch(AggregateException e)
            {
                ExceptionDispatchInfo.Capture(e.InnerException).Throw();
                return null;
            }
        }
コード例 #4
0
        /// <summary>
        /// Initiates the asynchronous execution of the DescribePipelines operation.
        /// </summary>
        /// 
        /// <param name="request">Container for the necessary parameters to execute the DescribePipelines operation on AmazonDataPipelineClient.</param>
        /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
        /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
        ///          procedure using the AsyncState property.</param>
        /// 
        /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePipelines
        ///         operation.</returns>
        public IAsyncResult BeginDescribePipelines(DescribePipelinesRequest request, AsyncCallback callback, object state)
        {
            var marshaller = new DescribePipelinesRequestMarshaller();
            var unmarshaller = DescribePipelinesResponseUnmarshaller.Instance;

            return BeginInvoke<DescribePipelinesRequest>(request, marshaller, unmarshaller,
                callback, state);
        }
コード例 #5
0
        /// <summary>
        /// Retrieves metadata about one or more pipelines. The information retrieved includes
        /// the name of the pipeline, the pipeline identifier, its current state, and the user
        /// account that owns the pipeline. Using account credentials, you can retrieve metadata
        /// about pipelines that you or your IAM users have created. If you are using an IAM user
        /// account, you can retrieve metadata about only those pipelines for which you have read
        /// permissions.
        /// 
        ///  
        /// <para>
        /// To retrieve the full pipeline definition instead of metadata about the pipeline, call
        /// <a>GetPipelineDefinition</a>.
        /// </para>
        /// </summary>
        /// <param name="request">Container for the necessary parameters to execute the DescribePipelines service method.</param>
        /// 
        /// <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns>
        /// <exception cref="Amazon.DataPipeline.Model.InternalServiceErrorException">
        /// An internal service error occurred.
        /// </exception>
        /// <exception cref="Amazon.DataPipeline.Model.InvalidRequestException">
        /// The request was not valid. Verify that your request was properly formatted, that the
        /// signature was generated with the correct credentials, and that you haven't exceeded
        /// any of the service limits for your account.
        /// </exception>
        /// <exception cref="Amazon.DataPipeline.Model.PipelineDeletedException">
        /// The specified pipeline has been deleted.
        /// </exception>
        /// <exception cref="Amazon.DataPipeline.Model.PipelineNotFoundException">
        /// The specified pipeline was not found. Verify that you used the correct user and account
        /// identifiers.
        /// </exception>
        public DescribePipelinesResponse DescribePipelines(DescribePipelinesRequest request)
        {
            var marshaller = new DescribePipelinesRequestMarshaller();
            var unmarshaller = DescribePipelinesResponseUnmarshaller.Instance;

            return Invoke<DescribePipelinesRequest,DescribePipelinesResponse>(request, marshaller, unmarshaller);
        }
コード例 #6
0
 /// <summary>
 /// Retrieves metadata about one or more pipelines. The information retrieved includes
 /// the name of the pipeline, the pipeline identifier, its current state, and the user
 /// account that owns the pipeline. Using account credentials, you can retrieve metadata
 /// about pipelines that you or your IAM users have created. If you are using an IAM user
 /// account, you can retrieve metadata about only those pipelines for which you have read
 /// permissions.
 /// 
 ///  
 /// <para>
 /// To retrieve the full pipeline definition instead of metadata about the pipeline, call
 /// <a>GetPipelineDefinition</a>.
 /// </para>
 /// </summary>
 /// <param name="pipelineIds">The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call <a>ListPipelines</a>.</param>
 /// 
 /// <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns>
 /// <exception cref="Amazon.DataPipeline.Model.InternalServiceErrorException">
 /// An internal service error occurred.
 /// </exception>
 /// <exception cref="Amazon.DataPipeline.Model.InvalidRequestException">
 /// The request was not valid. Verify that your request was properly formatted, that the
 /// signature was generated with the correct credentials, and that you haven't exceeded
 /// any of the service limits for your account.
 /// </exception>
 /// <exception cref="Amazon.DataPipeline.Model.PipelineDeletedException">
 /// The specified pipeline has been deleted.
 /// </exception>
 /// <exception cref="Amazon.DataPipeline.Model.PipelineNotFoundException">
 /// The specified pipeline was not found. Verify that you used the correct user and account
 /// identifiers.
 /// </exception>
 public DescribePipelinesResponse DescribePipelines(List<string> pipelineIds)
 {
     var request = new DescribePipelinesRequest();
     request.PipelineIds = pipelineIds;
     return DescribePipelines(request);
 }
コード例 #7
0
        /// <summary>
        /// Initiates the asynchronous execution of the DescribePipelines operation.
        /// <seealso cref="Amazon.DataPipeline.IAmazonDataPipeline.DescribePipelines"/>
        /// </summary>
        /// 
        /// <param name="request">Container for the necessary parameters to execute the DescribePipelines operation.</param>
        /// <param name="cancellationToken">
        ///     A cancellation token that can be used by other objects or threads to receive notice of cancellation.
        /// </param>
        /// <returns>The task object representing the asynchronous operation.</returns>
		public async Task<DescribePipelinesResponse> DescribePipelinesAsync(DescribePipelinesRequest request, CancellationToken cancellationToken = default(CancellationToken))
        {
            var marshaller = new DescribePipelinesRequestMarshaller();
            var unmarshaller = DescribePipelinesResponseUnmarshaller.GetInstance();
            var response = await Invoke<IRequest, DescribePipelinesRequest, DescribePipelinesResponse>(request, marshaller, unmarshaller, signer, cancellationToken)
                .ConfigureAwait(continueOnCapturedContext: false);
            return response;
        }
コード例 #8
0
        /// <summary>
        /// <para> Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier,
        /// its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that
        /// you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read
        /// permission for. </para> <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call the
        /// GetPipelineDefinition action. </para>
        /// </summary>
        /// 
        /// <param name="request">Container for the necessary parameters to execute the DescribePipelines service method on
        /// AmazonDataPipeline.</param>
        /// 
        /// <returns>The response from the DescribePipelines service method, as returned by AmazonDataPipeline.</returns>
        /// 
        /// <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException" />
        /// <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException" />
        /// <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException" />
        /// <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException" />
		public DescribePipelinesResponse DescribePipelines(DescribePipelinesRequest request)
        {
            var task = DescribePipelinesAsync(request);
            try
            {
                return task.Result;
            }
            catch(AggregateException e)
            {
                throw e.InnerException;
            }
        }
コード例 #9
0
 IAsyncResult invokeDescribePipelines(DescribePipelinesRequest describePipelinesRequest, AsyncCallback callback, object state, bool synchronized)
 {
     IRequest irequest = new DescribePipelinesRequestMarshaller().Marshall(describePipelinesRequest);
     var unmarshaller = DescribePipelinesResponseUnmarshaller.GetInstance();
     AsyncResult result = new AsyncResult(irequest, callback, state, synchronized, signer, unmarshaller);
     Invoke(result);
     return result;
 }
コード例 #10
0
 /// <summary>
 /// Initiates the asynchronous execution of the DescribePipelines operation.
 /// <seealso cref="Amazon.DataPipeline.IAmazonDataPipeline.DescribePipelines"/>
 /// </summary>
 /// 
 /// <param name="describePipelinesRequest">Container for the necessary parameters to execute the DescribePipelines operation on
 ///          AmazonDataPipeline.</param>
 /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
 /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
 ///          procedure using the AsyncState property.</param>
 /// 
 /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePipelines
 ///         operation.</returns>
 public IAsyncResult BeginDescribePipelines(DescribePipelinesRequest describePipelinesRequest, AsyncCallback callback, object state)
 {
     return invokeDescribePipelines(describePipelinesRequest, callback, state, false);
 }
コード例 #11
0
 /// <summary>
 /// <para> Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier,
 /// its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that
 /// you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read
 /// permission for. </para> <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call the
 /// GetPipelineDefinition action. </para>
 /// </summary>
 /// 
 /// <param name="describePipelinesRequest">Container for the necessary parameters to execute the DescribePipelines service method on
 ///          AmazonDataPipeline.</param>
 /// 
 /// <returns>The response from the DescribePipelines service method, as returned by AmazonDataPipeline.</returns>
 /// 
 /// <exception cref="PipelineNotFoundException"/>
 /// <exception cref="InternalServiceErrorException"/>
 /// <exception cref="InvalidRequestException"/>
 /// <exception cref="PipelineDeletedException"/>
 public DescribePipelinesResponse DescribePipelines(DescribePipelinesRequest describePipelinesRequest)
 {
     IAsyncResult asyncResult = invokeDescribePipelines(describePipelinesRequest, null, null, true);
     return EndDescribePipelines(asyncResult);
 }
コード例 #12
0
        /// <summary>
        /// Initiates the asynchronous execution of the DescribePipelines operation.
        /// </summary>
        /// 
        /// <param name="request">Container for the necessary parameters to execute the DescribePipelines operation.</param>
        /// <param name="cancellationToken">
        ///     A cancellation token that can be used by other objects or threads to receive notice of cancellation.
        /// </param>
        /// <returns>The task object representing the asynchronous operation.</returns>
        public Task<DescribePipelinesResponse> DescribePipelinesAsync(DescribePipelinesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
        {
            var marshaller = new DescribePipelinesRequestMarshaller();
            var unmarshaller = DescribePipelinesResponseUnmarshaller.Instance;

            return InvokeAsync<DescribePipelinesRequest,DescribePipelinesResponse>(request, marshaller, 
                unmarshaller, cancellationToken);
        }
コード例 #13
0
 private Amazon.DataPipeline.Model.DescribePipelinesResponse CallAWSServiceOperation(IAmazonDataPipeline client, Amazon.DataPipeline.Model.DescribePipelinesRequest request)
 {
     Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Data Pipeline", "DescribePipelines");
     try
     {
         #if DESKTOP
         return(client.DescribePipelines(request));
         #elif CORECLR
         return(client.DescribePipelinesAsync(request).GetAwaiter().GetResult());
         #else
                 #error "Unknown build edition"
         #endif
     }
     catch (AmazonServiceException exc)
     {
         var webException = exc.InnerException as System.Net.WebException;
         if (webException != null)
         {
             throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
         }
         throw;
     }
 }
コード例 #14
0
 /// <summary>
 /// Retrieves metadata about one or more pipelines. The information retrieved includes
 /// the name of the pipeline, the pipeline identifier, its current state, and the user
 /// account that owns the pipeline. Using account credentials, you can retrieve metadata
 /// about pipelines that you or your IAM users have created. If you are using an IAM user
 /// account, you can retrieve metadata about only those pipelines for which you have read
 /// permissions.
 /// 
 ///  
 /// <para>
 /// To retrieve the full pipeline definition instead of metadata about the pipeline, call
 /// <a>GetPipelineDefinition</a>.
 /// </para>
 /// </summary>
 /// <param name="pipelineIds">The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call <a>ListPipelines</a>.</param>
 /// <param name="cancellationToken">
 ///     A cancellation token that can be used by other objects or threads to receive notice of cancellation.
 /// </param>
 /// 
 /// <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns>
 /// <exception cref="Amazon.DataPipeline.Model.InternalServiceErrorException">
 /// An internal service error occurred.
 /// </exception>
 /// <exception cref="Amazon.DataPipeline.Model.InvalidRequestException">
 /// The request was not valid. Verify that your request was properly formatted, that the
 /// signature was generated with the correct credentials, and that you haven't exceeded
 /// any of the service limits for your account.
 /// </exception>
 /// <exception cref="Amazon.DataPipeline.Model.PipelineDeletedException">
 /// The specified pipeline has been deleted.
 /// </exception>
 /// <exception cref="Amazon.DataPipeline.Model.PipelineNotFoundException">
 /// The specified pipeline was not found. Verify that you used the correct user and account
 /// identifiers.
 /// </exception>
 public Task<DescribePipelinesResponse> DescribePipelinesAsync(List<string> pipelineIds, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
 {
     var request = new DescribePipelinesRequest();
     request.PipelineIds = pipelineIds;
     return DescribePipelinesAsync(request, cancellationToken);
 }