/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 * 
 *  http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

/*
 * Do not modify this file. This file is generated from the synthetics-2017-10-11.normal.json service model.
 */
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;

using Amazon.Runtime;
using Amazon.Runtime.Internal;

namespace Amazon.Synthetics.Model
{
    /// <summary>
    /// Container for the parameters to the DescribeCanaries operation.
    /// This operation returns a list of the canaries in your account, along with full details
    /// about each canary.
    /// 
    ///  
    /// <para>
    /// This operation supports resource-level authorization using an IAM policy and the <code>Names</code>
    /// parameter. If you specify the <code>Names</code> parameter, the operation is successful
    /// only if you have authorization to view all the canaries that you specify in your request.
    /// If you do not have permission to view any of the canaries, the request fails with
    /// a 403 response.
    /// </para>
    ///  
    /// <para>
    /// You are required to use the <code>Names</code> parameter if you are logged on to a
    /// user or role that has an IAM policy that restricts which canaries that you are allowed
    /// to view. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html">
    /// Limiting a user to viewing specific canaries</a>.
    /// </para>
    /// </summary>
    public partial class DescribeCanariesRequest : AmazonSyntheticsRequest
    {
        private int? _maxResults;
        private List<string> _names = new List<string>();
        private string _nextToken;

        /// <summary>
        /// Gets and sets the property MaxResults. 
        /// <para>
        /// Specify this parameter to limit how many canaries are returned each time you use the
        /// <code>DescribeCanaries</code> operation. If you omit this parameter, the default of
        /// 100 is used.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=20)]
        public int MaxResults
        {
            get { return this._maxResults.GetValueOrDefault(); }
            set { this._maxResults = value; }
        }

        // Check to see if MaxResults property is set
        internal bool IsSetMaxResults()
        {
            return this._maxResults.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property Names. 
        /// <para>
        /// Use this parameter to return only canaries that match the names that you specify here.
        /// You can specify as many as five canary names.
        /// </para>
        ///  
        /// <para>
        /// If you specify this parameter, the operation is successful only if you have authorization
        /// to view all the canaries that you specify in your request. If you do not have permission
        /// to view any of the canaries, the request fails with a 403 response.
        /// </para>
        ///  
        /// <para>
        /// You are required to use this parameter if you are logged on to a user or role that
        /// has an IAM policy that restricts which canaries that you are allowed to view. For
        /// more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html">
        /// Limiting a user to viewing specific canaries</a>.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=5)]
        public List<string> Names
        {
            get { return this._names; }
            set { this._names = value; }
        }

        // Check to see if Names property is set
        internal bool IsSetNames()
        {
            return this._names != null && this._names.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property NextToken. 
        /// <para>
        /// A token that indicates that there is more data available. You can use this token in
        /// a subsequent operation to retrieve the next set of results.
        /// </para>
        /// </summary>
        [AWSProperty(Min=4, Max=252)]
        public string NextToken
        {
            get { return this._nextToken; }
            set { this._nextToken = value; }
        }

        // Check to see if NextToken property is set
        internal bool IsSetNextToken()
        {
            return this._nextToken != null;
        }

    }
}