repo_name
stringlengths 1
52
| repo_creator
stringclasses 6
values | programming_language
stringclasses 4
values | code
stringlengths 0
9.68M
| num_lines
int64 1
234k
|
|---|---|---|---|---|
aws-sdk-net | aws | C# | /*
* 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 acm-pca-2017-08-22.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Text;
using System.Collections;
using System.Threading;
using System.Threading.Tasks;
using Amazon.Runtime;
namespace Amazon.ACMPCA.Model
{
/// <summary>
/// Base class for ListPermissions paginators.
/// </summary>
internal sealed partial class ListPermissionsPaginator : IPaginator<ListPermissionsResponse>, IListPermissionsPaginator
{
private readonly IAmazonACMPCA _client;
private readonly ListPermissionsRequest _request;
private int _isPaginatorInUse = 0;
/// <summary>
/// Enumerable containing all full responses for the operation
/// </summary>
public IPaginatedEnumerable<ListPermissionsResponse> Responses => new PaginatedResponse<ListPermissionsResponse>(this);
/// <summary>
/// Enumerable containing all of the Permissions
/// </summary>
public IPaginatedEnumerable<Permission> Permissions =>
new PaginatedResultKeyResponse<ListPermissionsResponse, Permission>(this, (i) => i.Permissions);
internal ListPermissionsPaginator(IAmazonACMPCA client, ListPermissionsRequest request)
{
this._client = client;
this._request = request;
}
#if BCL
IEnumerable<ListPermissionsResponse> IPaginator<ListPermissionsResponse>.Paginate()
{
if (Interlocked.Exchange(ref _isPaginatorInUse, 1) != 0)
{
throw new System.InvalidOperationException("Paginator has already been consumed and cannot be reused. Please create a new instance.");
}
PaginatorUtils.SetUserAgentAdditionOnRequest(_request);
var nextToken = _request.NextToken;
ListPermissionsResponse response;
do
{
_request.NextToken = nextToken;
response = _client.ListPermissions(_request);
nextToken = response.NextToken;
yield return response;
}
while (!string.IsNullOrEmpty(nextToken));
}
#endif
#if AWS_ASYNC_ENUMERABLES_API
async IAsyncEnumerable<ListPermissionsResponse> IPaginator<ListPermissionsResponse>.PaginateAsync(CancellationToken cancellationToken = default)
{
if (Interlocked.Exchange(ref _isPaginatorInUse, 1) != 0)
{
throw new System.InvalidOperationException("Paginator has already been consumed and cannot be reused. Please create a new instance.");
}
PaginatorUtils.SetUserAgentAdditionOnRequest(_request);
var nextToken = _request.NextToken;
ListPermissionsResponse response;
do
{
_request.NextToken = nextToken;
response = await _client.ListPermissionsAsync(_request, cancellationToken).ConfigureAwait(false);
nextToken = response.NextToken;
cancellationToken.ThrowIfCancellationRequested();
yield return response;
}
while (!string.IsNullOrEmpty(nextToken));
}
#endif
}
} | 97 |
aws-sdk-net | aws | C# | /*
* 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 acm-pca-2017-08-22.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Text;
using System.Collections;
using System.Threading;
using System.Threading.Tasks;
using Amazon.Runtime;
namespace Amazon.ACMPCA.Model
{
/// <summary>
/// Base class for ListTags paginators.
/// </summary>
internal sealed partial class ListTagsPaginator : IPaginator<ListTagsResponse>, IListTagsPaginator
{
private readonly IAmazonACMPCA _client;
private readonly ListTagsRequest _request;
private int _isPaginatorInUse = 0;
/// <summary>
/// Enumerable containing all full responses for the operation
/// </summary>
public IPaginatedEnumerable<ListTagsResponse> Responses => new PaginatedResponse<ListTagsResponse>(this);
/// <summary>
/// Enumerable containing all of the Tags
/// </summary>
public IPaginatedEnumerable<Tag> Tags =>
new PaginatedResultKeyResponse<ListTagsResponse, Tag>(this, (i) => i.Tags);
internal ListTagsPaginator(IAmazonACMPCA client, ListTagsRequest request)
{
this._client = client;
this._request = request;
}
#if BCL
IEnumerable<ListTagsResponse> IPaginator<ListTagsResponse>.Paginate()
{
if (Interlocked.Exchange(ref _isPaginatorInUse, 1) != 0)
{
throw new System.InvalidOperationException("Paginator has already been consumed and cannot be reused. Please create a new instance.");
}
PaginatorUtils.SetUserAgentAdditionOnRequest(_request);
var nextToken = _request.NextToken;
ListTagsResponse response;
do
{
_request.NextToken = nextToken;
response = _client.ListTags(_request);
nextToken = response.NextToken;
yield return response;
}
while (!string.IsNullOrEmpty(nextToken));
}
#endif
#if AWS_ASYNC_ENUMERABLES_API
async IAsyncEnumerable<ListTagsResponse> IPaginator<ListTagsResponse>.PaginateAsync(CancellationToken cancellationToken = default)
{
if (Interlocked.Exchange(ref _isPaginatorInUse, 1) != 0)
{
throw new System.InvalidOperationException("Paginator has already been consumed and cannot be reused. Please create a new instance.");
}
PaginatorUtils.SetUserAgentAdditionOnRequest(_request);
var nextToken = _request.NextToken;
ListTagsResponse response;
do
{
_request.NextToken = nextToken;
response = await _client.ListTagsAsync(_request, cancellationToken).ConfigureAwait(false);
nextToken = response.NextToken;
cancellationToken.ThrowIfCancellationRequested();
yield return response;
}
while (!string.IsNullOrEmpty(nextToken));
}
#endif
}
} | 97 |
aws-sdk-net | aws | C# | /*
* 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 acm-pca-2017-08-22.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Net;
using Amazon.ACMPCA.Model;
using Amazon.ACMPCA.Model.Internal.MarshallTransformations;
using Amazon.ACMPCA.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.ACMPCA
{
/// <summary>
/// Implementation for accessing ACMPCA
///
/// This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>.
/// It provides descriptions, syntax, and usage examples for each of the actions and data
/// types involved in creating and managing a private certificate authority (CA) for your
/// organization.
///
///
/// <para>
/// The documentation for each action shows the API request parameters and the JSON response.
/// Alternatively, you can use one of the Amazon Web Services SDKs to access an API that
/// is tailored to the programming language or platform that you prefer. For more information,
/// see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.
/// </para>
///
/// <para>
/// Each Amazon Web Services Private CA API operation has a quota that determines the
/// number of times the operation can be called per second. Amazon Web Services Private
/// CA throttles API requests at different rates depending on the operation. Throttling
/// means that Amazon Web Services Private CA rejects an otherwise valid request because
/// the request exceeds the operation's quota for the number of requests per second. When
/// a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a>
/// error. Amazon Web Services Private CA does not guarantee a minimum request rate for
/// APIs.
/// </para>
///
/// <para>
/// To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request
/// a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service
/// Quotas</a> console.
/// </para>
/// </summary>
public partial class AmazonACMPCAClient : AmazonServiceClient, IAmazonACMPCA
{
private static IServiceMetadata serviceMetadata = new AmazonACMPCAMetadata();
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
private IACMPCAPaginatorFactory _paginators;
/// <summary>
/// Paginators for the service
/// </summary>
public IACMPCAPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new ACMPCAPaginatorFactory(this);
}
return this._paginators;
}
}
#endif
#region Constructors
/// <summary>
/// Constructs AmazonACMPCAClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
public AmazonACMPCAClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonACMPCAConfig()) { }
/// <summary>
/// Constructs AmazonACMPCAClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonACMPCAConfig{RegionEndpoint = region}) { }
/// <summary>
/// Constructs AmazonACMPCAClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
/// <param name="config">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(AmazonACMPCAConfig config)
: base(FallbackCredentialsFactory.GetCredentials(), config) { }
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Credentials
/// </summary>
/// <param name="credentials">AWS Credentials</param>
public AmazonACMPCAClient(AWSCredentials credentials)
: this(credentials, new AmazonACMPCAConfig())
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Credentials
/// </summary>
/// <param name="credentials">AWS Credentials</param>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonACMPCAConfig{RegionEndpoint = region})
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Credentials and an
/// AmazonACMPCAClient Configuration object.
/// </summary>
/// <param name="credentials">AWS Credentials</param>
/// <param name="clientConfig">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(AWSCredentials credentials, AmazonACMPCAConfig clientConfig)
: base(credentials, clientConfig)
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonACMPCAConfig())
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonACMPCAConfig() {RegionEndpoint=region})
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonACMPCAClient Configuration object.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="clientConfig">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonACMPCAConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonACMPCAConfig())
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonACMPCAConfig{RegionEndpoint = region})
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonACMPCAClient Configuration object.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
/// <param name="clientConfig">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonACMPCAConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
/// <summary>
/// Creates the signer for the service.
/// </summary>
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
/// <summary>
/// Customize the pipeline
/// </summary>
/// <param name="pipeline"></param>
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler<Amazon.Runtime.Internal.EndpointResolver>();
pipeline.AddHandlerAfter<Amazon.Runtime.Internal.Marshaller>(new AmazonACMPCAEndpointResolver());
}
/// <summary>
/// Capture metadata for the service.
/// </summary>
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
/// <summary>
/// Disposes the service client.
/// </summary>
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region CreateCertificateAuthority
/// <summary>
/// Creates a root or subordinate private certificate authority (CA). You must specify
/// the CA configuration, an optional configuration for Online Certificate Status Protocol
/// (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency
/// token to avoid accidental creation of multiple CAs. The CA configuration specifies
/// the name of the algorithm and key size to be used to create the CA private key, the
/// type of signing algorithm that the CA uses, and X.500 subject information. The OCSP
/// configuration can optionally specify a custom URL for the OCSP responder. The CRL
/// configuration specifies the CRL expiration period in days (the validity period of
/// the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the
/// S3 bucket that is included in certificates issued by the CA. If successful, this action
/// returns the Amazon Resource Name (ARN) of the CA.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting
/// Your CRLs</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority service method.</param>
///
/// <returns>The response from the CreateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
public virtual CreateCertificateAuthorityResponse CreateCertificateAuthority(CreateCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<CreateCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the CreateCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority operation on AmazonACMPCAClient.</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 EndCreateCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
public virtual IAsyncResult BeginCreateCertificateAuthority(CreateCertificateAuthorityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the CreateCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCertificateAuthority.</param>
///
/// <returns>Returns a CreateCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
public virtual CreateCertificateAuthorityResponse EndCreateCertificateAuthority(IAsyncResult asyncResult)
{
return EndInvoke<CreateCertificateAuthorityResponse>(asyncResult);
}
#endregion
#region CreateCertificateAuthorityAuditReport
/// <summary>
/// Creates an audit report that lists every time that your CA private key is used. The
/// report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// actions use the private key.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting
/// Your Audit Reports</a>.
/// </para>
/// <note>
/// <para>
/// You can generate a maximum of one report every 30 minutes.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport service method.</param>
///
/// <returns>The response from the CreateCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
public virtual CreateCertificateAuthorityAuditReportResponse CreateCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return Invoke<CreateCertificateAuthorityAuditReportResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the CreateCertificateAuthorityAuditReport operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport operation on AmazonACMPCAClient.</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 EndCreateCertificateAuthorityAuditReport
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
public virtual IAsyncResult BeginCreateCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the CreateCertificateAuthorityAuditReport operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCertificateAuthorityAuditReport.</param>
///
/// <returns>Returns a CreateCertificateAuthorityAuditReportResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
public virtual CreateCertificateAuthorityAuditReportResponse EndCreateCertificateAuthorityAuditReport(IAsyncResult asyncResult)
{
return EndInvoke<CreateCertificateAuthorityAuditReportResponse>(asyncResult);
}
#endregion
#region CreatePermission
/// <summary>
/// Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
/// principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
/// renew ACM certificates that reside in the same Amazon Web Services account as the
/// CA.
///
///
/// <para>
/// You can list current permissions with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action and revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreatePermission service method.</param>
///
/// <returns>The response from the CreatePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.PermissionAlreadyExistsException">
/// The designated permission has already been given to the user.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
public virtual CreatePermissionResponse CreatePermission(CreatePermissionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreatePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreatePermissionResponseUnmarshaller.Instance;
return Invoke<CreatePermissionResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the CreatePermission operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the CreatePermission operation on AmazonACMPCAClient.</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 EndCreatePermission
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
public virtual IAsyncResult BeginCreatePermission(CreatePermissionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreatePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreatePermissionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the CreatePermission operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePermission.</param>
///
/// <returns>Returns a CreatePermissionResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
public virtual CreatePermissionResponse EndCreatePermission(IAsyncResult asyncResult)
{
return EndInvoke<CreatePermissionResponse>(asyncResult);
}
#endregion
#region DeleteCertificateAuthority
/// <summary>
/// Deletes a private certificate authority (CA). You must provide the Amazon Resource
/// Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
/// the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// action.
///
/// <note>
/// <para>
/// Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
/// </para>
/// </note>
/// <para>
/// Before you can delete a CA that you have created and activated, you must disable it.
/// To do this, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>.
///
/// </para>
///
/// <para>
/// Additionally, you can delete a CA if you are waiting for it to be created (that is,
/// the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
/// been created but you haven't yet imported the signed certificate into Amazon Web Services
/// Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>).
/// </para>
///
/// <para>
/// When you successfully call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>,
/// the CA's status changes to <code>DELETED</code>. However, the CA won't be permanently
/// deleted until the restoration period has passed. By default, if you do not set the
/// <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for
/// 30 days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// action returns the time remaining in the restoration window of a private CA in the
/// <code>DELETED</code> state. To restore an eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a>
/// action.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority service method.</param>
///
/// <returns>The response from the DeleteCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
public virtual DeleteCertificateAuthorityResponse DeleteCertificateAuthority(DeleteCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<DeleteCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the DeleteCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority operation on AmazonACMPCAClient.</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 EndDeleteCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
public virtual IAsyncResult BeginDeleteCertificateAuthority(DeleteCertificateAuthorityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCertificateAuthorityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the DeleteCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCertificateAuthority.</param>
///
/// <returns>Returns a DeleteCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
public virtual DeleteCertificateAuthorityResponse EndDeleteCertificateAuthority(IAsyncResult asyncResult)
{
return EndInvoke<DeleteCertificateAuthorityResponse>(asyncResult);
}
#endregion
#region DeletePermission
/// <summary>
/// Revokes permissions on a private CA granted to the Certificate Manager (ACM) service
/// principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA. If you revoke these permissions, ACM will
/// no longer renew the affected certificates automatically.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePermission service method.</param>
///
/// <returns>The response from the DeletePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
public virtual DeletePermissionResponse DeletePermission(DeletePermissionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePermissionResponseUnmarshaller.Instance;
return Invoke<DeletePermissionResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the DeletePermission operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DeletePermission operation on AmazonACMPCAClient.</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 EndDeletePermission
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
public virtual IAsyncResult BeginDeletePermission(DeletePermissionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePermissionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the DeletePermission operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePermission.</param>
///
/// <returns>Returns a DeletePermissionResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
public virtual DeletePermissionResponse EndDeletePermission(IAsyncResult asyncResult)
{
return EndInvoke<DeletePermissionResponse>(asyncResult);
}
#endregion
#region DeletePolicy
/// <summary>
/// Deletes the resource-based policy attached to a private CA. Deletion will remove any
/// access that the policy has granted. If there is no policy attached to the private
/// CA, this action will return successful.
///
///
/// <para>
/// If you delete a policy that was applied through Amazon Web Services Resource Access
/// Manager (RAM), the CA will be removed from all shares in which it was included.
/// </para>
///
/// <para>
/// The Certificate Manager Service Linked Role that the policy supports is not affected
/// when you delete the policy.
/// </para>
///
/// <para>
/// The current policy can be shown with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param>
///
/// <returns>The response from the DeletePolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
public virtual DeletePolicyResponse DeletePolicy(DeletePolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePolicyResponseUnmarshaller.Instance;
return Invoke<DeletePolicyResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the DeletePolicy operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy operation on AmazonACMPCAClient.</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 EndDeletePolicy
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
public virtual IAsyncResult BeginDeletePolicy(DeletePolicyRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePolicyResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the DeletePolicy operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePolicy.</param>
///
/// <returns>Returns a DeletePolicyResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
public virtual DeletePolicyResponse EndDeletePolicy(IAsyncResult asyncResult)
{
return EndInvoke<DeletePolicyResponse>(asyncResult);
}
#endregion
#region DescribeCertificateAuthority
/// <summary>
/// Lists information about your private certificate authority (CA) or one that has been
/// shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
/// The output contains the status of your CA. This can be any of the following:
///
/// <ul> <li>
/// <para>
/// <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
/// authority.
/// </para>
/// </li> <li>
/// <para>
/// <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your
/// Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign
/// your private CA CSR and then import it into Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>ACTIVE</code> - Your private CA is active.
/// </para>
/// </li> <li>
/// <para>
/// <code>DISABLED</code> - Your private CA has been disabled.
/// </para>
/// </li> <li>
/// <para>
/// <code>EXPIRED</code> - Your private CA certificate has expired.
/// </para>
/// </li> <li>
/// <para>
/// <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems
/// such a network outage or back-end Amazon Web Services failure or other errors. A failed
/// CA can never return to the pending state. You must create a new CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>DELETED</code> - Your private CA is within the restoration period, after which
/// it is permanently deleted. The length of time remaining in the CA's restoration period
/// is also included in this action's output.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority service method.</param>
///
/// <returns>The response from the DescribeCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
public virtual DescribeCertificateAuthorityResponse DescribeCertificateAuthority(DescribeCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<DescribeCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority operation on AmazonACMPCAClient.</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 EndDescribeCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
public virtual IAsyncResult BeginDescribeCertificateAuthority(DescribeCertificateAuthorityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the DescribeCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCertificateAuthority.</param>
///
/// <returns>Returns a DescribeCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
public virtual DescribeCertificateAuthorityResponse EndDescribeCertificateAuthority(IAsyncResult asyncResult)
{
return EndInvoke<DescribeCertificateAuthorityResponse>(asyncResult);
}
#endregion
#region DescribeCertificateAuthorityAuditReport
/// <summary>
/// Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action. Audit information is created every time the certificate authority (CA) private
/// key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport service method.</param>
///
/// <returns>The response from the DescribeCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
public virtual DescribeCertificateAuthorityAuditReportResponse DescribeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return Invoke<DescribeCertificateAuthorityAuditReportResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeCertificateAuthorityAuditReport operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport operation on AmazonACMPCAClient.</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 EndDescribeCertificateAuthorityAuditReport
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
public virtual IAsyncResult BeginDescribeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the DescribeCertificateAuthorityAuditReport operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCertificateAuthorityAuditReport.</param>
///
/// <returns>Returns a DescribeCertificateAuthorityAuditReportResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
public virtual DescribeCertificateAuthorityAuditReportResponse EndDescribeCertificateAuthorityAuditReport(IAsyncResult asyncResult)
{
return EndInvoke<DescribeCertificateAuthorityAuditReportResponse>(asyncResult);
}
#endregion
#region GetCertificate
/// <summary>
/// Retrieves a certificate from your private CA or one that has been shared with you.
/// The ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action. You must specify both the ARN of your private CA and the ARN of the issued
/// certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate
/// if it is in the <b>ISSUED</b> state. You can call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action to create a report that contains information about all of the certificates
/// issued and revoked by your private CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificate service method.</param>
///
/// <returns>The response from the GetCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
public virtual GetCertificateResponse GetCertificate(GetCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateResponseUnmarshaller.Instance;
return Invoke<GetCertificateResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the GetCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetCertificate operation on AmazonACMPCAClient.</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 EndGetCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
public virtual IAsyncResult BeginGetCertificate(GetCertificateRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the GetCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCertificate.</param>
///
/// <returns>Returns a GetCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
public virtual GetCertificateResponse EndGetCertificate(IAsyncResult asyncResult)
{
return EndInvoke<GetCertificateResponse>(asyncResult);
}
#endregion
#region GetCertificateAuthorityCertificate
/// <summary>
/// Retrieves the certificate and certificate chain for your private certificate authority
/// (CA) or one that has been shared with you. Both the certificate and the chain are
/// base64 PEM-encoded. The chain does not include the CA certificate. Each certificate
/// in the chain signs the one before it.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate service method.</param>
///
/// <returns>The response from the GetCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
public virtual GetCertificateAuthorityCertificateResponse GetCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return Invoke<GetCertificateAuthorityCertificateResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the GetCertificateAuthorityCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate operation on AmazonACMPCAClient.</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 EndGetCertificateAuthorityCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
public virtual IAsyncResult BeginGetCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the GetCertificateAuthorityCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCertificateAuthorityCertificate.</param>
///
/// <returns>Returns a GetCertificateAuthorityCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
public virtual GetCertificateAuthorityCertificateResponse EndGetCertificateAuthorityCertificate(IAsyncResult asyncResult)
{
return EndInvoke<GetCertificateAuthorityCertificateResponse>(asyncResult);
}
#endregion
#region GetCertificateAuthorityCsr
/// <summary>
/// Retrieves the certificate signing request (CSR) for your private certificate authority
/// (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises
/// root or subordinate CA. Then import the signed certificate back into Amazon Web Services
/// Private CA by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action. The CSR is returned as a base64 PEM-encoded string.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr service method.</param>
///
/// <returns>The response from the GetCertificateAuthorityCsr service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
public virtual GetCertificateAuthorityCsrResponse GetCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCsrRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCsrResponseUnmarshaller.Instance;
return Invoke<GetCertificateAuthorityCsrResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the GetCertificateAuthorityCsr operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr operation on AmazonACMPCAClient.</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 EndGetCertificateAuthorityCsr
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
public virtual IAsyncResult BeginGetCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCsrRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCsrResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the GetCertificateAuthorityCsr operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCertificateAuthorityCsr.</param>
///
/// <returns>Returns a GetCertificateAuthorityCsrResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
public virtual GetCertificateAuthorityCsrResponse EndGetCertificateAuthorityCsr(IAsyncResult asyncResult)
{
return EndInvoke<GetCertificateAuthorityCsrResponse>(asyncResult);
}
#endregion
#region GetPolicy
/// <summary>
/// Retrieves the resource-based policy attached to a private CA. If either the private
/// CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>.
///
///
///
/// <para>
/// The policy can be attached or updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</param>
///
/// <returns>The response from the GetPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
public virtual GetPolicyResponse GetPolicy(GetPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPolicyResponseUnmarshaller.Instance;
return Invoke<GetPolicyResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the GetPolicy operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetPolicy operation on AmazonACMPCAClient.</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 EndGetPolicy
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
public virtual IAsyncResult BeginGetPolicy(GetPolicyRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPolicyResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the GetPolicy operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPolicy.</param>
///
/// <returns>Returns a GetPolicyResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
public virtual GetPolicyResponse EndGetPolicy(IAsyncResult asyncResult)
{
return EndInvoke<GetPolicyResponse>(asyncResult);
}
#endregion
#region ImportCertificateAuthorityCertificate
/// <summary>
/// Imports a signed private CA certificate into Amazon Web Services Private CA. This
/// action is used when you are using a chain of trust whose root is located outside Amazon
/// Web Services Private CA. Before you can call this action, the following preparations
/// must in place:
///
/// <ol> <li>
/// <para>
/// In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action to create the private CA that you plan to back with the imported certificate.
/// </para>
/// </li> <li>
/// <para>
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a>
/// action to generate a certificate signing request (CSR).
/// </para>
/// </li> <li>
/// <para>
/// Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy
/// or by a commercial CA.
/// </para>
/// </li> <li>
/// <para>
/// Create a certificate chain and copy the signed certificate and the certificate chain
/// to your working directory.
/// </para>
/// </li> </ol>
/// <para>
/// Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
/// </para>
/// <ul> <li>
/// <para>
/// Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is hosted by Amazon
/// Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is externally hosted.
/// </para>
/// </li> </ul>
/// <para>
/// The following additional requirements apply when you import a CA certificate.
/// </para>
/// <ul> <li>
/// <para>
/// Only a self-signed certificate can be imported as a root CA.
/// </para>
/// </li> <li>
/// <para>
/// A self-signed certificate cannot be imported as a subordinate CA.
/// </para>
/// </li> <li>
/// <para>
/// Your certificate chain must not include the private CA certificate that you are importing.
/// </para>
/// </li> <li>
/// <para>
/// Your root CA must be the last certificate in your chain. The subordinate certificate,
/// if any, that your root CA signed must be next to last. The subordinate certificate
/// signed by the preceding subordinate CA must come next, and so on until your chain
/// is built.
/// </para>
/// </li> <li>
/// <para>
/// The chain must be PEM-encoded.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate is 32 KB.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate chain is 2 MB.
/// </para>
/// </li> </ul>
/// <para>
/// <i>Enforcement of Critical Constraints</i>
/// </para>
///
/// <para>
/// Amazon Web Services Private CA allows the following extensions to be marked critical
/// in the imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Basic constraints (<i>must</i> be marked critical)
/// </para>
/// </li> <li>
/// <para>
/// Subject alternative names
/// </para>
/// </li> <li>
/// <para>
/// Key usage
/// </para>
/// </li> <li>
/// <para>
/// Extended key usage
/// </para>
/// </li> <li>
/// <para>
/// Authority key identifier
/// </para>
/// </li> <li>
/// <para>
/// Subject key identifier
/// </para>
/// </li> <li>
/// <para>
/// Issuer alternative name
/// </para>
/// </li> <li>
/// <para>
/// Subject directory attributes
/// </para>
/// </li> <li>
/// <para>
/// Subject information access
/// </para>
/// </li> <li>
/// <para>
/// Certificate policies
/// </para>
/// </li> <li>
/// <para>
/// Policy mappings
/// </para>
/// </li> <li>
/// <para>
/// Inhibit anyPolicy
/// </para>
/// </li> </ul>
/// <para>
/// Amazon Web Services Private CA rejects the following extensions when they are marked
/// critical in an imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Name constraints
/// </para>
/// </li> <li>
/// <para>
/// Policy constraints
/// </para>
/// </li> <li>
/// <para>
/// CRL distribution points
/// </para>
/// </li> <li>
/// <para>
/// Authority information access
/// </para>
/// </li> <li>
/// <para>
/// Freshest CRL
/// </para>
/// </li> <li>
/// <para>
/// Any other extension
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate service method.</param>
///
/// <returns>The response from the ImportCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.CertificateMismatchException">
/// The certificate authority certificate you are importing does not comply with conditions
/// specified in the certificate that signed it.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCertificateException">
/// One or more fields in the certificate are invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
public virtual ImportCertificateAuthorityCertificateResponse ImportCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ImportCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = ImportCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return Invoke<ImportCertificateAuthorityCertificateResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the ImportCertificateAuthorityCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate operation on AmazonACMPCAClient.</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 EndImportCertificateAuthorityCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
public virtual IAsyncResult BeginImportCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ImportCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = ImportCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the ImportCertificateAuthorityCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginImportCertificateAuthorityCertificate.</param>
///
/// <returns>Returns a ImportCertificateAuthorityCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
public virtual ImportCertificateAuthorityCertificateResponse EndImportCertificateAuthorityCertificate(IAsyncResult asyncResult)
{
return EndInvoke<ImportCertificateAuthorityCertificateResponse>(asyncResult);
}
#endregion
#region IssueCertificate
/// <summary>
/// Uses your private certificate authority (CA), or one that has been shared with you,
/// to issue a client certificate. This action returns the Amazon Resource Name (ARN)
/// of the certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a>
/// action and specifying the ARN.
///
/// <note>
/// <para>
/// You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs
/// of the certificates that you issue by using Amazon Web Services Private CA.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate service method.</param>
///
/// <returns>The response from the IssueCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCSRException">
/// The certificate signing request is invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
public virtual IssueCertificateResponse IssueCertificate(IssueCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = IssueCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = IssueCertificateResponseUnmarshaller.Instance;
return Invoke<IssueCertificateResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the IssueCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate operation on AmazonACMPCAClient.</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 EndIssueCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
public virtual IAsyncResult BeginIssueCertificate(IssueCertificateRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = IssueCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = IssueCertificateResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the IssueCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginIssueCertificate.</param>
///
/// <returns>Returns a IssueCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
public virtual IssueCertificateResponse EndIssueCertificate(IAsyncResult asyncResult)
{
return EndInvoke<IssueCertificateResponse>(asyncResult);
}
#endregion
#region ListCertificateAuthorities
/// <summary>
/// Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities service method.</param>
///
/// <returns>The response from the ListCertificateAuthorities service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
public virtual ListCertificateAuthoritiesResponse ListCertificateAuthorities(ListCertificateAuthoritiesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCertificateAuthoritiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCertificateAuthoritiesResponseUnmarshaller.Instance;
return Invoke<ListCertificateAuthoritiesResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the ListCertificateAuthorities operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities operation on AmazonACMPCAClient.</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 EndListCertificateAuthorities
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
public virtual IAsyncResult BeginListCertificateAuthorities(ListCertificateAuthoritiesRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCertificateAuthoritiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCertificateAuthoritiesResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the ListCertificateAuthorities operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginListCertificateAuthorities.</param>
///
/// <returns>Returns a ListCertificateAuthoritiesResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
public virtual ListCertificateAuthoritiesResponse EndListCertificateAuthorities(IAsyncResult asyncResult)
{
return EndInvoke<ListCertificateAuthoritiesResponse>(asyncResult);
}
#endregion
#region ListPermissions
/// <summary>
/// List all permissions on a private CA, if any, granted to the Certificate Manager (ACM)
/// service principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListPermissions service method.</param>
///
/// <returns>The response from the ListPermissions service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
public virtual ListPermissionsResponse ListPermissions(ListPermissionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPermissionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPermissionsResponseUnmarshaller.Instance;
return Invoke<ListPermissionsResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the ListPermissions operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListPermissions operation on AmazonACMPCAClient.</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 EndListPermissions
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
public virtual IAsyncResult BeginListPermissions(ListPermissionsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPermissionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPermissionsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the ListPermissions operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginListPermissions.</param>
///
/// <returns>Returns a ListPermissionsResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
public virtual ListPermissionsResponse EndListPermissions(IAsyncResult asyncResult)
{
return EndInvoke<ListPermissionsResponse>(asyncResult);
}
#endregion
#region ListTags
/// <summary>
/// Lists the tags, if any, that are associated with your private CA or one that has been
/// shared with you. Tags are labels that you can use to identify and organize your CAs.
/// Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
/// action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action to remove tags.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListTags service method.</param>
///
/// <returns>The response from the ListTags service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
public virtual ListTagsResponse ListTags(ListTagsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsResponseUnmarshaller.Instance;
return Invoke<ListTagsResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the ListTags operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListTags operation on AmazonACMPCAClient.</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 EndListTags
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
public virtual IAsyncResult BeginListTags(ListTagsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the ListTags operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginListTags.</param>
///
/// <returns>Returns a ListTagsResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
public virtual ListTagsResponse EndListTags(IAsyncResult asyncResult)
{
return EndInvoke<ListTagsResponse>(asyncResult);
}
#endregion
#region PutPolicy
/// <summary>
/// Attaches a resource-based policy to a private CA.
///
///
/// <para>
/// A policy can also be applied by sharing a private CA through Amazon Web Services Resource
/// Access Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
///
/// <para>
/// The policy can be displayed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the PutPolicy service method.</param>
///
/// <returns>The response from the PutPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
public virtual PutPolicyResponse PutPolicy(PutPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutPolicyResponseUnmarshaller.Instance;
return Invoke<PutPolicyResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the PutPolicy operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the PutPolicy operation on AmazonACMPCAClient.</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 EndPutPolicy
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
public virtual IAsyncResult BeginPutPolicy(PutPolicyRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutPolicyResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the PutPolicy operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutPolicy.</param>
///
/// <returns>Returns a PutPolicyResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
public virtual PutPolicyResponse EndPutPolicy(IAsyncResult asyncResult)
{
return EndInvoke<PutPolicyResponse>(asyncResult);
}
#endregion
#region RestoreCertificateAuthority
/// <summary>
/// Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
/// can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b>
/// parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>
/// action. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b>
/// value, by default you can restore the CA at any time in a 30 day period. You can check
/// the time remaining in the restoration period of a private CA in the <code>DELETED</code>
/// state by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// or <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// actions. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b>
/// action returns. To change its status to <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion,
/// you must use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action to import a certificate authority into the private CA before it can be activated.
/// You cannot restore a CA after the restoration period has ended.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority service method.</param>
///
/// <returns>The response from the RestoreCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
public virtual RestoreCertificateAuthorityResponse RestoreCertificateAuthority(RestoreCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<RestoreCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the RestoreCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority operation on AmazonACMPCAClient.</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 EndRestoreCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
public virtual IAsyncResult BeginRestoreCertificateAuthority(RestoreCertificateAuthorityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreCertificateAuthorityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the RestoreCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginRestoreCertificateAuthority.</param>
///
/// <returns>Returns a RestoreCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
public virtual RestoreCertificateAuthorityResponse EndRestoreCertificateAuthority(IAsyncResult asyncResult)
{
return EndInvoke<RestoreCertificateAuthorityResponse>(asyncResult);
}
#endregion
#region RevokeCertificate
/// <summary>
/// Revokes a certificate that was issued inside Amazon Web Services Private CA. If you
/// enable a certificate revocation list (CRL) when you create or update your private
/// CA, information about the revoked certificates will be included in the CRL. Amazon
/// Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is
/// typically updated approximately 30 minutes after a certificate is revoked. If for
/// any reason the CRL update fails, Amazon Web Services Private CA attempts makes further
/// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
/// <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information,
/// see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported
/// CloudWatch Metrics</a>.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA also writes revocation information to the audit report.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.
/// </para>
/// <note>
/// <para>
/// You cannot revoke a root CA self-signed certificate.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate service method.</param>
///
/// <returns>The response from the RevokeCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestAlreadyProcessedException">
/// Your request has already been completed.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
public virtual RevokeCertificateResponse RevokeCertificate(RevokeCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RevokeCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = RevokeCertificateResponseUnmarshaller.Instance;
return Invoke<RevokeCertificateResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the RevokeCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate operation on AmazonACMPCAClient.</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 EndRevokeCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
public virtual IAsyncResult BeginRevokeCertificate(RevokeCertificateRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = RevokeCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = RevokeCertificateResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the RevokeCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginRevokeCertificate.</param>
///
/// <returns>Returns a RevokeCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
public virtual RevokeCertificateResponse EndRevokeCertificate(IAsyncResult asyncResult)
{
return EndInvoke<RevokeCertificateResponse>(asyncResult);
}
#endregion
#region TagCertificateAuthority
/// <summary>
/// Adds one or more tags to your private CA. Tags are labels that you can use to identify
/// and organize your Amazon Web Services resources. Each tag consists of a key and an
/// optional value. You specify the private CA on input by its Amazon Resource Name (ARN).
/// You specify the tag by using a key-value pair. You can apply a tag to just one private
/// CA if you want to identify a specific characteristic of that CA, or you can apply
/// the same tag to multiple private CAs if you want to filter for a common relationship
/// among those CAs. To remove one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
///
/// <note>
/// <para>
/// To attach tags to a private CA during the creation procedure, a CA administrator must
/// first associate an inline IAM policy with the <code>CreateCertificateAuthority</code>
/// action and explicitly allow tagging. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching
/// tags to a CA at the time of creation</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority service method.</param>
///
/// <returns>The response from the TagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.TooManyTagsException">
/// You can associate up to 50 tags with a private CA. Exception information is contained
/// in the exception message field.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
public virtual TagCertificateAuthorityResponse TagCertificateAuthority(TagCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<TagCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the TagCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority operation on AmazonACMPCAClient.</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 EndTagCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
public virtual IAsyncResult BeginTagCertificateAuthority(TagCertificateAuthorityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagCertificateAuthorityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the TagCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginTagCertificateAuthority.</param>
///
/// <returns>Returns a TagCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
public virtual TagCertificateAuthorityResponse EndTagCertificateAuthority(IAsyncResult asyncResult)
{
return EndInvoke<TagCertificateAuthorityResponse>(asyncResult);
}
#endregion
#region UntagCertificateAuthority
/// <summary>
/// Remove one or more tags from your private CA. A tag consists of a key-value pair.
/// If you do not specify the value portion of the tag when calling this action, the tag
/// will be removed regardless of value. If you specify a value, the tag is removed only
/// if it is associated with the specified value. To add tags to a private CA, use the
/// <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>.
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority service method.</param>
///
/// <returns>The response from the UntagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
public virtual UntagCertificateAuthorityResponse UntagCertificateAuthority(UntagCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<UntagCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the UntagCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority operation on AmazonACMPCAClient.</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 EndUntagCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
public virtual IAsyncResult BeginUntagCertificateAuthority(UntagCertificateAuthorityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagCertificateAuthorityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the UntagCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginUntagCertificateAuthority.</param>
///
/// <returns>Returns a UntagCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
public virtual UntagCertificateAuthorityResponse EndUntagCertificateAuthority(IAsyncResult asyncResult)
{
return EndInvoke<UntagCertificateAuthorityResponse>(asyncResult);
}
#endregion
#region UpdateCertificateAuthority
/// <summary>
/// Updates the status or configuration of a private certificate authority (CA). Your
/// private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before
/// you can update it. You can disable a private CA that is in the <code>ACTIVE</code>
/// state or make a CA that is in the <code>DISABLED</code> state active again.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority service method.</param>
///
/// <returns>The response from the UpdateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
public virtual UpdateCertificateAuthorityResponse UpdateCertificateAuthority(UpdateCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<UpdateCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Initiates the asynchronous execution of the UpdateCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority operation on AmazonACMPCAClient.</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 EndUpdateCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
public virtual IAsyncResult BeginUpdateCertificateAuthority(UpdateCertificateAuthorityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCertificateAuthorityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
/// <summary>
/// Finishes the asynchronous execution of the UpdateCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateCertificateAuthority.</param>
///
/// <returns>Returns a UpdateCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
public virtual UpdateCertificateAuthorityResponse EndUpdateCertificateAuthority(IAsyncResult asyncResult)
{
return EndInvoke<UpdateCertificateAuthorityResponse>(asyncResult);
}
#endregion
}
} | 2,534 |
aws-sdk-net | aws | C# | /*
* 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 acm-pca-2017-08-22.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.ACMPCA.Model;
namespace Amazon.ACMPCA
{
/// <summary>
/// Interface for accessing ACMPCA
///
/// This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>.
/// It provides descriptions, syntax, and usage examples for each of the actions and data
/// types involved in creating and managing a private certificate authority (CA) for your
/// organization.
///
///
/// <para>
/// The documentation for each action shows the API request parameters and the JSON response.
/// Alternatively, you can use one of the Amazon Web Services SDKs to access an API that
/// is tailored to the programming language or platform that you prefer. For more information,
/// see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.
/// </para>
///
/// <para>
/// Each Amazon Web Services Private CA API operation has a quota that determines the
/// number of times the operation can be called per second. Amazon Web Services Private
/// CA throttles API requests at different rates depending on the operation. Throttling
/// means that Amazon Web Services Private CA rejects an otherwise valid request because
/// the request exceeds the operation's quota for the number of requests per second. When
/// a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a>
/// error. Amazon Web Services Private CA does not guarantee a minimum request rate for
/// APIs.
/// </para>
///
/// <para>
/// To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request
/// a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service
/// Quotas</a> console.
/// </para>
/// </summary>
public partial interface IAmazonACMPCA : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
/// <summary>
/// Paginators for the service
/// </summary>
IACMPCAPaginatorFactory Paginators { get; }
#endif
#region CreateCertificateAuthority
/// <summary>
/// Creates a root or subordinate private certificate authority (CA). You must specify
/// the CA configuration, an optional configuration for Online Certificate Status Protocol
/// (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency
/// token to avoid accidental creation of multiple CAs. The CA configuration specifies
/// the name of the algorithm and key size to be used to create the CA private key, the
/// type of signing algorithm that the CA uses, and X.500 subject information. The OCSP
/// configuration can optionally specify a custom URL for the OCSP responder. The CRL
/// configuration specifies the CRL expiration period in days (the validity period of
/// the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the
/// S3 bucket that is included in certificates issued by the CA. If successful, this action
/// returns the Amazon Resource Name (ARN) of the CA.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting
/// Your CRLs</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority service method.</param>
///
/// <returns>The response from the CreateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
CreateCertificateAuthorityResponse CreateCertificateAuthority(CreateCertificateAuthorityRequest request);
/// <summary>
/// Initiates the asynchronous execution of the CreateCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority operation on AmazonACMPCAClient.</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 EndCreateCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
IAsyncResult BeginCreateCertificateAuthority(CreateCertificateAuthorityRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the CreateCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCertificateAuthority.</param>
///
/// <returns>Returns a CreateCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
CreateCertificateAuthorityResponse EndCreateCertificateAuthority(IAsyncResult asyncResult);
#endregion
#region CreateCertificateAuthorityAuditReport
/// <summary>
/// Creates an audit report that lists every time that your CA private key is used. The
/// report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// actions use the private key.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting
/// Your Audit Reports</a>.
/// </para>
/// <note>
/// <para>
/// You can generate a maximum of one report every 30 minutes.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport service method.</param>
///
/// <returns>The response from the CreateCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
CreateCertificateAuthorityAuditReportResponse CreateCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest request);
/// <summary>
/// Initiates the asynchronous execution of the CreateCertificateAuthorityAuditReport operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport operation on AmazonACMPCAClient.</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 EndCreateCertificateAuthorityAuditReport
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
IAsyncResult BeginCreateCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the CreateCertificateAuthorityAuditReport operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCertificateAuthorityAuditReport.</param>
///
/// <returns>Returns a CreateCertificateAuthorityAuditReportResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
CreateCertificateAuthorityAuditReportResponse EndCreateCertificateAuthorityAuditReport(IAsyncResult asyncResult);
#endregion
#region CreatePermission
/// <summary>
/// Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
/// principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
/// renew ACM certificates that reside in the same Amazon Web Services account as the
/// CA.
///
///
/// <para>
/// You can list current permissions with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action and revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreatePermission service method.</param>
///
/// <returns>The response from the CreatePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.PermissionAlreadyExistsException">
/// The designated permission has already been given to the user.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
CreatePermissionResponse CreatePermission(CreatePermissionRequest request);
/// <summary>
/// Initiates the asynchronous execution of the CreatePermission operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the CreatePermission operation on AmazonACMPCAClient.</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 EndCreatePermission
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
IAsyncResult BeginCreatePermission(CreatePermissionRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the CreatePermission operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePermission.</param>
///
/// <returns>Returns a CreatePermissionResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
CreatePermissionResponse EndCreatePermission(IAsyncResult asyncResult);
#endregion
#region DeleteCertificateAuthority
/// <summary>
/// Deletes a private certificate authority (CA). You must provide the Amazon Resource
/// Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
/// the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// action.
///
/// <note>
/// <para>
/// Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
/// </para>
/// </note>
/// <para>
/// Before you can delete a CA that you have created and activated, you must disable it.
/// To do this, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>.
///
/// </para>
///
/// <para>
/// Additionally, you can delete a CA if you are waiting for it to be created (that is,
/// the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
/// been created but you haven't yet imported the signed certificate into Amazon Web Services
/// Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>).
/// </para>
///
/// <para>
/// When you successfully call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>,
/// the CA's status changes to <code>DELETED</code>. However, the CA won't be permanently
/// deleted until the restoration period has passed. By default, if you do not set the
/// <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for
/// 30 days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// action returns the time remaining in the restoration window of a private CA in the
/// <code>DELETED</code> state. To restore an eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a>
/// action.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority service method.</param>
///
/// <returns>The response from the DeleteCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
DeleteCertificateAuthorityResponse DeleteCertificateAuthority(DeleteCertificateAuthorityRequest request);
/// <summary>
/// Initiates the asynchronous execution of the DeleteCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority operation on AmazonACMPCAClient.</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 EndDeleteCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
IAsyncResult BeginDeleteCertificateAuthority(DeleteCertificateAuthorityRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the DeleteCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCertificateAuthority.</param>
///
/// <returns>Returns a DeleteCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
DeleteCertificateAuthorityResponse EndDeleteCertificateAuthority(IAsyncResult asyncResult);
#endregion
#region DeletePermission
/// <summary>
/// Revokes permissions on a private CA granted to the Certificate Manager (ACM) service
/// principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA. If you revoke these permissions, ACM will
/// no longer renew the affected certificates automatically.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePermission service method.</param>
///
/// <returns>The response from the DeletePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
DeletePermissionResponse DeletePermission(DeletePermissionRequest request);
/// <summary>
/// Initiates the asynchronous execution of the DeletePermission operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DeletePermission operation on AmazonACMPCAClient.</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 EndDeletePermission
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
IAsyncResult BeginDeletePermission(DeletePermissionRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the DeletePermission operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePermission.</param>
///
/// <returns>Returns a DeletePermissionResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
DeletePermissionResponse EndDeletePermission(IAsyncResult asyncResult);
#endregion
#region DeletePolicy
/// <summary>
/// Deletes the resource-based policy attached to a private CA. Deletion will remove any
/// access that the policy has granted. If there is no policy attached to the private
/// CA, this action will return successful.
///
///
/// <para>
/// If you delete a policy that was applied through Amazon Web Services Resource Access
/// Manager (RAM), the CA will be removed from all shares in which it was included.
/// </para>
///
/// <para>
/// The Certificate Manager Service Linked Role that the policy supports is not affected
/// when you delete the policy.
/// </para>
///
/// <para>
/// The current policy can be shown with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param>
///
/// <returns>The response from the DeletePolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
DeletePolicyResponse DeletePolicy(DeletePolicyRequest request);
/// <summary>
/// Initiates the asynchronous execution of the DeletePolicy operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy operation on AmazonACMPCAClient.</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 EndDeletePolicy
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
IAsyncResult BeginDeletePolicy(DeletePolicyRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the DeletePolicy operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePolicy.</param>
///
/// <returns>Returns a DeletePolicyResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
DeletePolicyResponse EndDeletePolicy(IAsyncResult asyncResult);
#endregion
#region DescribeCertificateAuthority
/// <summary>
/// Lists information about your private certificate authority (CA) or one that has been
/// shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
/// The output contains the status of your CA. This can be any of the following:
///
/// <ul> <li>
/// <para>
/// <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
/// authority.
/// </para>
/// </li> <li>
/// <para>
/// <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your
/// Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign
/// your private CA CSR and then import it into Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>ACTIVE</code> - Your private CA is active.
/// </para>
/// </li> <li>
/// <para>
/// <code>DISABLED</code> - Your private CA has been disabled.
/// </para>
/// </li> <li>
/// <para>
/// <code>EXPIRED</code> - Your private CA certificate has expired.
/// </para>
/// </li> <li>
/// <para>
/// <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems
/// such a network outage or back-end Amazon Web Services failure or other errors. A failed
/// CA can never return to the pending state. You must create a new CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>DELETED</code> - Your private CA is within the restoration period, after which
/// it is permanently deleted. The length of time remaining in the CA's restoration period
/// is also included in this action's output.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority service method.</param>
///
/// <returns>The response from the DescribeCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
DescribeCertificateAuthorityResponse DescribeCertificateAuthority(DescribeCertificateAuthorityRequest request);
/// <summary>
/// Initiates the asynchronous execution of the DescribeCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority operation on AmazonACMPCAClient.</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 EndDescribeCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
IAsyncResult BeginDescribeCertificateAuthority(DescribeCertificateAuthorityRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the DescribeCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCertificateAuthority.</param>
///
/// <returns>Returns a DescribeCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
DescribeCertificateAuthorityResponse EndDescribeCertificateAuthority(IAsyncResult asyncResult);
#endregion
#region DescribeCertificateAuthorityAuditReport
/// <summary>
/// Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action. Audit information is created every time the certificate authority (CA) private
/// key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport service method.</param>
///
/// <returns>The response from the DescribeCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
DescribeCertificateAuthorityAuditReportResponse DescribeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest request);
/// <summary>
/// Initiates the asynchronous execution of the DescribeCertificateAuthorityAuditReport operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport operation on AmazonACMPCAClient.</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 EndDescribeCertificateAuthorityAuditReport
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
IAsyncResult BeginDescribeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the DescribeCertificateAuthorityAuditReport operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCertificateAuthorityAuditReport.</param>
///
/// <returns>Returns a DescribeCertificateAuthorityAuditReportResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
DescribeCertificateAuthorityAuditReportResponse EndDescribeCertificateAuthorityAuditReport(IAsyncResult asyncResult);
#endregion
#region GetCertificate
/// <summary>
/// Retrieves a certificate from your private CA or one that has been shared with you.
/// The ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action. You must specify both the ARN of your private CA and the ARN of the issued
/// certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate
/// if it is in the <b>ISSUED</b> state. You can call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action to create a report that contains information about all of the certificates
/// issued and revoked by your private CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificate service method.</param>
///
/// <returns>The response from the GetCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
GetCertificateResponse GetCertificate(GetCertificateRequest request);
/// <summary>
/// Initiates the asynchronous execution of the GetCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetCertificate operation on AmazonACMPCAClient.</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 EndGetCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
IAsyncResult BeginGetCertificate(GetCertificateRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the GetCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCertificate.</param>
///
/// <returns>Returns a GetCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
GetCertificateResponse EndGetCertificate(IAsyncResult asyncResult);
#endregion
#region GetCertificateAuthorityCertificate
/// <summary>
/// Retrieves the certificate and certificate chain for your private certificate authority
/// (CA) or one that has been shared with you. Both the certificate and the chain are
/// base64 PEM-encoded. The chain does not include the CA certificate. Each certificate
/// in the chain signs the one before it.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate service method.</param>
///
/// <returns>The response from the GetCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
GetCertificateAuthorityCertificateResponse GetCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest request);
/// <summary>
/// Initiates the asynchronous execution of the GetCertificateAuthorityCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate operation on AmazonACMPCAClient.</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 EndGetCertificateAuthorityCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
IAsyncResult BeginGetCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the GetCertificateAuthorityCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCertificateAuthorityCertificate.</param>
///
/// <returns>Returns a GetCertificateAuthorityCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
GetCertificateAuthorityCertificateResponse EndGetCertificateAuthorityCertificate(IAsyncResult asyncResult);
#endregion
#region GetCertificateAuthorityCsr
/// <summary>
/// Retrieves the certificate signing request (CSR) for your private certificate authority
/// (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises
/// root or subordinate CA. Then import the signed certificate back into Amazon Web Services
/// Private CA by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action. The CSR is returned as a base64 PEM-encoded string.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr service method.</param>
///
/// <returns>The response from the GetCertificateAuthorityCsr service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
GetCertificateAuthorityCsrResponse GetCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest request);
/// <summary>
/// Initiates the asynchronous execution of the GetCertificateAuthorityCsr operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr operation on AmazonACMPCAClient.</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 EndGetCertificateAuthorityCsr
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
IAsyncResult BeginGetCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the GetCertificateAuthorityCsr operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCertificateAuthorityCsr.</param>
///
/// <returns>Returns a GetCertificateAuthorityCsrResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
GetCertificateAuthorityCsrResponse EndGetCertificateAuthorityCsr(IAsyncResult asyncResult);
#endregion
#region GetPolicy
/// <summary>
/// Retrieves the resource-based policy attached to a private CA. If either the private
/// CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>.
///
///
///
/// <para>
/// The policy can be attached or updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</param>
///
/// <returns>The response from the GetPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
GetPolicyResponse GetPolicy(GetPolicyRequest request);
/// <summary>
/// Initiates the asynchronous execution of the GetPolicy operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the GetPolicy operation on AmazonACMPCAClient.</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 EndGetPolicy
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
IAsyncResult BeginGetPolicy(GetPolicyRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the GetPolicy operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPolicy.</param>
///
/// <returns>Returns a GetPolicyResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
GetPolicyResponse EndGetPolicy(IAsyncResult asyncResult);
#endregion
#region ImportCertificateAuthorityCertificate
/// <summary>
/// Imports a signed private CA certificate into Amazon Web Services Private CA. This
/// action is used when you are using a chain of trust whose root is located outside Amazon
/// Web Services Private CA. Before you can call this action, the following preparations
/// must in place:
///
/// <ol> <li>
/// <para>
/// In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action to create the private CA that you plan to back with the imported certificate.
/// </para>
/// </li> <li>
/// <para>
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a>
/// action to generate a certificate signing request (CSR).
/// </para>
/// </li> <li>
/// <para>
/// Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy
/// or by a commercial CA.
/// </para>
/// </li> <li>
/// <para>
/// Create a certificate chain and copy the signed certificate and the certificate chain
/// to your working directory.
/// </para>
/// </li> </ol>
/// <para>
/// Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
/// </para>
/// <ul> <li>
/// <para>
/// Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is hosted by Amazon
/// Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is externally hosted.
/// </para>
/// </li> </ul>
/// <para>
/// The following additional requirements apply when you import a CA certificate.
/// </para>
/// <ul> <li>
/// <para>
/// Only a self-signed certificate can be imported as a root CA.
/// </para>
/// </li> <li>
/// <para>
/// A self-signed certificate cannot be imported as a subordinate CA.
/// </para>
/// </li> <li>
/// <para>
/// Your certificate chain must not include the private CA certificate that you are importing.
/// </para>
/// </li> <li>
/// <para>
/// Your root CA must be the last certificate in your chain. The subordinate certificate,
/// if any, that your root CA signed must be next to last. The subordinate certificate
/// signed by the preceding subordinate CA must come next, and so on until your chain
/// is built.
/// </para>
/// </li> <li>
/// <para>
/// The chain must be PEM-encoded.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate is 32 KB.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate chain is 2 MB.
/// </para>
/// </li> </ul>
/// <para>
/// <i>Enforcement of Critical Constraints</i>
/// </para>
///
/// <para>
/// Amazon Web Services Private CA allows the following extensions to be marked critical
/// in the imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Basic constraints (<i>must</i> be marked critical)
/// </para>
/// </li> <li>
/// <para>
/// Subject alternative names
/// </para>
/// </li> <li>
/// <para>
/// Key usage
/// </para>
/// </li> <li>
/// <para>
/// Extended key usage
/// </para>
/// </li> <li>
/// <para>
/// Authority key identifier
/// </para>
/// </li> <li>
/// <para>
/// Subject key identifier
/// </para>
/// </li> <li>
/// <para>
/// Issuer alternative name
/// </para>
/// </li> <li>
/// <para>
/// Subject directory attributes
/// </para>
/// </li> <li>
/// <para>
/// Subject information access
/// </para>
/// </li> <li>
/// <para>
/// Certificate policies
/// </para>
/// </li> <li>
/// <para>
/// Policy mappings
/// </para>
/// </li> <li>
/// <para>
/// Inhibit anyPolicy
/// </para>
/// </li> </ul>
/// <para>
/// Amazon Web Services Private CA rejects the following extensions when they are marked
/// critical in an imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Name constraints
/// </para>
/// </li> <li>
/// <para>
/// Policy constraints
/// </para>
/// </li> <li>
/// <para>
/// CRL distribution points
/// </para>
/// </li> <li>
/// <para>
/// Authority information access
/// </para>
/// </li> <li>
/// <para>
/// Freshest CRL
/// </para>
/// </li> <li>
/// <para>
/// Any other extension
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate service method.</param>
///
/// <returns>The response from the ImportCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.CertificateMismatchException">
/// The certificate authority certificate you are importing does not comply with conditions
/// specified in the certificate that signed it.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCertificateException">
/// One or more fields in the certificate are invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
ImportCertificateAuthorityCertificateResponse ImportCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest request);
/// <summary>
/// Initiates the asynchronous execution of the ImportCertificateAuthorityCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate operation on AmazonACMPCAClient.</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 EndImportCertificateAuthorityCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
IAsyncResult BeginImportCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the ImportCertificateAuthorityCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginImportCertificateAuthorityCertificate.</param>
///
/// <returns>Returns a ImportCertificateAuthorityCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
ImportCertificateAuthorityCertificateResponse EndImportCertificateAuthorityCertificate(IAsyncResult asyncResult);
#endregion
#region IssueCertificate
/// <summary>
/// Uses your private certificate authority (CA), or one that has been shared with you,
/// to issue a client certificate. This action returns the Amazon Resource Name (ARN)
/// of the certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a>
/// action and specifying the ARN.
///
/// <note>
/// <para>
/// You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs
/// of the certificates that you issue by using Amazon Web Services Private CA.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate service method.</param>
///
/// <returns>The response from the IssueCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCSRException">
/// The certificate signing request is invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
IssueCertificateResponse IssueCertificate(IssueCertificateRequest request);
/// <summary>
/// Initiates the asynchronous execution of the IssueCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate operation on AmazonACMPCAClient.</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 EndIssueCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
IAsyncResult BeginIssueCertificate(IssueCertificateRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the IssueCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginIssueCertificate.</param>
///
/// <returns>Returns a IssueCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
IssueCertificateResponse EndIssueCertificate(IAsyncResult asyncResult);
#endregion
#region ListCertificateAuthorities
/// <summary>
/// Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities service method.</param>
///
/// <returns>The response from the ListCertificateAuthorities service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
ListCertificateAuthoritiesResponse ListCertificateAuthorities(ListCertificateAuthoritiesRequest request);
/// <summary>
/// Initiates the asynchronous execution of the ListCertificateAuthorities operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities operation on AmazonACMPCAClient.</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 EndListCertificateAuthorities
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
IAsyncResult BeginListCertificateAuthorities(ListCertificateAuthoritiesRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the ListCertificateAuthorities operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginListCertificateAuthorities.</param>
///
/// <returns>Returns a ListCertificateAuthoritiesResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
ListCertificateAuthoritiesResponse EndListCertificateAuthorities(IAsyncResult asyncResult);
#endregion
#region ListPermissions
/// <summary>
/// List all permissions on a private CA, if any, granted to the Certificate Manager (ACM)
/// service principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListPermissions service method.</param>
///
/// <returns>The response from the ListPermissions service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
ListPermissionsResponse ListPermissions(ListPermissionsRequest request);
/// <summary>
/// Initiates the asynchronous execution of the ListPermissions operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListPermissions operation on AmazonACMPCAClient.</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 EndListPermissions
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
IAsyncResult BeginListPermissions(ListPermissionsRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the ListPermissions operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginListPermissions.</param>
///
/// <returns>Returns a ListPermissionsResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
ListPermissionsResponse EndListPermissions(IAsyncResult asyncResult);
#endregion
#region ListTags
/// <summary>
/// Lists the tags, if any, that are associated with your private CA or one that has been
/// shared with you. Tags are labels that you can use to identify and organize your CAs.
/// Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
/// action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action to remove tags.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListTags service method.</param>
///
/// <returns>The response from the ListTags service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
ListTagsResponse ListTags(ListTagsRequest request);
/// <summary>
/// Initiates the asynchronous execution of the ListTags operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListTags operation on AmazonACMPCAClient.</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 EndListTags
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
IAsyncResult BeginListTags(ListTagsRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the ListTags operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginListTags.</param>
///
/// <returns>Returns a ListTagsResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
ListTagsResponse EndListTags(IAsyncResult asyncResult);
#endregion
#region PutPolicy
/// <summary>
/// Attaches a resource-based policy to a private CA.
///
///
/// <para>
/// A policy can also be applied by sharing a private CA through Amazon Web Services Resource
/// Access Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
///
/// <para>
/// The policy can be displayed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the PutPolicy service method.</param>
///
/// <returns>The response from the PutPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
PutPolicyResponse PutPolicy(PutPolicyRequest request);
/// <summary>
/// Initiates the asynchronous execution of the PutPolicy operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the PutPolicy operation on AmazonACMPCAClient.</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 EndPutPolicy
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
IAsyncResult BeginPutPolicy(PutPolicyRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the PutPolicy operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutPolicy.</param>
///
/// <returns>Returns a PutPolicyResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
PutPolicyResponse EndPutPolicy(IAsyncResult asyncResult);
#endregion
#region RestoreCertificateAuthority
/// <summary>
/// Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
/// can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b>
/// parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>
/// action. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b>
/// value, by default you can restore the CA at any time in a 30 day period. You can check
/// the time remaining in the restoration period of a private CA in the <code>DELETED</code>
/// state by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// or <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// actions. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b>
/// action returns. To change its status to <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion,
/// you must use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action to import a certificate authority into the private CA before it can be activated.
/// You cannot restore a CA after the restoration period has ended.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority service method.</param>
///
/// <returns>The response from the RestoreCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
RestoreCertificateAuthorityResponse RestoreCertificateAuthority(RestoreCertificateAuthorityRequest request);
/// <summary>
/// Initiates the asynchronous execution of the RestoreCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority operation on AmazonACMPCAClient.</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 EndRestoreCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
IAsyncResult BeginRestoreCertificateAuthority(RestoreCertificateAuthorityRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the RestoreCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginRestoreCertificateAuthority.</param>
///
/// <returns>Returns a RestoreCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
RestoreCertificateAuthorityResponse EndRestoreCertificateAuthority(IAsyncResult asyncResult);
#endregion
#region RevokeCertificate
/// <summary>
/// Revokes a certificate that was issued inside Amazon Web Services Private CA. If you
/// enable a certificate revocation list (CRL) when you create or update your private
/// CA, information about the revoked certificates will be included in the CRL. Amazon
/// Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is
/// typically updated approximately 30 minutes after a certificate is revoked. If for
/// any reason the CRL update fails, Amazon Web Services Private CA attempts makes further
/// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
/// <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information,
/// see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported
/// CloudWatch Metrics</a>.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA also writes revocation information to the audit report.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.
/// </para>
/// <note>
/// <para>
/// You cannot revoke a root CA self-signed certificate.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate service method.</param>
///
/// <returns>The response from the RevokeCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestAlreadyProcessedException">
/// Your request has already been completed.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
RevokeCertificateResponse RevokeCertificate(RevokeCertificateRequest request);
/// <summary>
/// Initiates the asynchronous execution of the RevokeCertificate operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate operation on AmazonACMPCAClient.</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 EndRevokeCertificate
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
IAsyncResult BeginRevokeCertificate(RevokeCertificateRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the RevokeCertificate operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginRevokeCertificate.</param>
///
/// <returns>Returns a RevokeCertificateResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
RevokeCertificateResponse EndRevokeCertificate(IAsyncResult asyncResult);
#endregion
#region TagCertificateAuthority
/// <summary>
/// Adds one or more tags to your private CA. Tags are labels that you can use to identify
/// and organize your Amazon Web Services resources. Each tag consists of a key and an
/// optional value. You specify the private CA on input by its Amazon Resource Name (ARN).
/// You specify the tag by using a key-value pair. You can apply a tag to just one private
/// CA if you want to identify a specific characteristic of that CA, or you can apply
/// the same tag to multiple private CAs if you want to filter for a common relationship
/// among those CAs. To remove one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
///
/// <note>
/// <para>
/// To attach tags to a private CA during the creation procedure, a CA administrator must
/// first associate an inline IAM policy with the <code>CreateCertificateAuthority</code>
/// action and explicitly allow tagging. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching
/// tags to a CA at the time of creation</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority service method.</param>
///
/// <returns>The response from the TagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.TooManyTagsException">
/// You can associate up to 50 tags with a private CA. Exception information is contained
/// in the exception message field.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
TagCertificateAuthorityResponse TagCertificateAuthority(TagCertificateAuthorityRequest request);
/// <summary>
/// Initiates the asynchronous execution of the TagCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority operation on AmazonACMPCAClient.</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 EndTagCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
IAsyncResult BeginTagCertificateAuthority(TagCertificateAuthorityRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the TagCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginTagCertificateAuthority.</param>
///
/// <returns>Returns a TagCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
TagCertificateAuthorityResponse EndTagCertificateAuthority(IAsyncResult asyncResult);
#endregion
#region UntagCertificateAuthority
/// <summary>
/// Remove one or more tags from your private CA. A tag consists of a key-value pair.
/// If you do not specify the value portion of the tag when calling this action, the tag
/// will be removed regardless of value. If you specify a value, the tag is removed only
/// if it is associated with the specified value. To add tags to a private CA, use the
/// <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>.
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority service method.</param>
///
/// <returns>The response from the UntagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
UntagCertificateAuthorityResponse UntagCertificateAuthority(UntagCertificateAuthorityRequest request);
/// <summary>
/// Initiates the asynchronous execution of the UntagCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority operation on AmazonACMPCAClient.</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 EndUntagCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
IAsyncResult BeginUntagCertificateAuthority(UntagCertificateAuthorityRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the UntagCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginUntagCertificateAuthority.</param>
///
/// <returns>Returns a UntagCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
UntagCertificateAuthorityResponse EndUntagCertificateAuthority(IAsyncResult asyncResult);
#endregion
#region UpdateCertificateAuthority
/// <summary>
/// Updates the status or configuration of a private certificate authority (CA). Your
/// private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before
/// you can update it. You can disable a private CA that is in the <code>ACTIVE</code>
/// state or make a CA that is in the <code>DISABLED</code> state active again.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority service method.</param>
///
/// <returns>The response from the UpdateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
UpdateCertificateAuthorityResponse UpdateCertificateAuthority(UpdateCertificateAuthorityRequest request);
/// <summary>
/// Initiates the asynchronous execution of the UpdateCertificateAuthority operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority operation on AmazonACMPCAClient.</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 EndUpdateCertificateAuthority
/// operation.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
IAsyncResult BeginUpdateCertificateAuthority(UpdateCertificateAuthorityRequest request, AsyncCallback callback, object state);
/// <summary>
/// Finishes the asynchronous execution of the UpdateCertificateAuthority operation.
/// </summary>
///
/// <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateCertificateAuthority.</param>
///
/// <returns>Returns a UpdateCertificateAuthorityResult from ACMPCA.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
UpdateCertificateAuthorityResponse EndUpdateCertificateAuthority(IAsyncResult asyncResult);
#endregion
}
} | 1,992 |
aws-sdk-net | aws | C# | /*
* 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 acm-pca-2017-08-22.normal.json service model.
*/
using System;
using System.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Net;
using Amazon.ACMPCA.Model;
using Amazon.ACMPCA.Model.Internal.MarshallTransformations;
using Amazon.ACMPCA.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.ACMPCA
{
/// <summary>
/// Implementation for accessing ACMPCA
///
/// This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>.
/// It provides descriptions, syntax, and usage examples for each of the actions and data
/// types involved in creating and managing a private certificate authority (CA) for your
/// organization.
///
///
/// <para>
/// The documentation for each action shows the API request parameters and the JSON response.
/// Alternatively, you can use one of the Amazon Web Services SDKs to access an API that
/// is tailored to the programming language or platform that you prefer. For more information,
/// see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.
/// </para>
///
/// <para>
/// Each Amazon Web Services Private CA API operation has a quota that determines the
/// number of times the operation can be called per second. Amazon Web Services Private
/// CA throttles API requests at different rates depending on the operation. Throttling
/// means that Amazon Web Services Private CA rejects an otherwise valid request because
/// the request exceeds the operation's quota for the number of requests per second. When
/// a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a>
/// error. Amazon Web Services Private CA does not guarantee a minimum request rate for
/// APIs.
/// </para>
///
/// <para>
/// To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request
/// a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service
/// Quotas</a> console.
/// </para>
/// </summary>
public partial class AmazonACMPCAClient : AmazonServiceClient, IAmazonACMPCA
{
private static IServiceMetadata serviceMetadata = new AmazonACMPCAMetadata();
private IACMPCAPaginatorFactory _paginators;
/// <summary>
/// Paginators for the service
/// </summary>
public IACMPCAPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new ACMPCAPaginatorFactory(this);
}
return this._paginators;
}
}
#region Constructors
/// <summary>
/// Constructs AmazonACMPCAClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
public AmazonACMPCAClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonACMPCAConfig()) { }
/// <summary>
/// Constructs AmazonACMPCAClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonACMPCAConfig{RegionEndpoint = region}) { }
/// <summary>
/// Constructs AmazonACMPCAClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
/// <param name="config">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(AmazonACMPCAConfig config)
: base(FallbackCredentialsFactory.GetCredentials(), config) { }
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Credentials
/// </summary>
/// <param name="credentials">AWS Credentials</param>
public AmazonACMPCAClient(AWSCredentials credentials)
: this(credentials, new AmazonACMPCAConfig())
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Credentials
/// </summary>
/// <param name="credentials">AWS Credentials</param>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonACMPCAConfig{RegionEndpoint = region})
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Credentials and an
/// AmazonACMPCAClient Configuration object.
/// </summary>
/// <param name="credentials">AWS Credentials</param>
/// <param name="clientConfig">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(AWSCredentials credentials, AmazonACMPCAConfig clientConfig)
: base(credentials, clientConfig)
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonACMPCAConfig())
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonACMPCAConfig() {RegionEndpoint=region})
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonACMPCAClient Configuration object.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="clientConfig">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonACMPCAConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonACMPCAConfig())
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonACMPCAConfig{RegionEndpoint = region})
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonACMPCAClient Configuration object.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
/// <param name="clientConfig">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonACMPCAConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
/// <summary>
/// Creates the signer for the service.
/// </summary>
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
/// <summary>
/// Customize the pipeline
/// </summary>
/// <param name="pipeline"></param>
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler<Amazon.Runtime.Internal.EndpointResolver>();
pipeline.AddHandlerAfter<Amazon.Runtime.Internal.Marshaller>(new AmazonACMPCAEndpointResolver());
}
/// <summary>
/// Capture metadata for the service.
/// </summary>
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
/// <summary>
/// Disposes the service client.
/// </summary>
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region CreateCertificateAuthority
/// <summary>
/// Creates a root or subordinate private certificate authority (CA). You must specify
/// the CA configuration, an optional configuration for Online Certificate Status Protocol
/// (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency
/// token to avoid accidental creation of multiple CAs. The CA configuration specifies
/// the name of the algorithm and key size to be used to create the CA private key, the
/// type of signing algorithm that the CA uses, and X.500 subject information. The OCSP
/// configuration can optionally specify a custom URL for the OCSP responder. The CRL
/// configuration specifies the CRL expiration period in days (the validity period of
/// the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the
/// S3 bucket that is included in certificates issued by the CA. If successful, this action
/// returns the Amazon Resource Name (ARN) of the CA.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting
/// Your CRLs</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority service method.</param>
///
/// <returns>The response from the CreateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
public virtual CreateCertificateAuthorityResponse CreateCertificateAuthority(CreateCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<CreateCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Creates a root or subordinate private certificate authority (CA). You must specify
/// the CA configuration, an optional configuration for Online Certificate Status Protocol
/// (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency
/// token to avoid accidental creation of multiple CAs. The CA configuration specifies
/// the name of the algorithm and key size to be used to create the CA private key, the
/// type of signing algorithm that the CA uses, and X.500 subject information. The OCSP
/// configuration can optionally specify a custom URL for the OCSP responder. The CRL
/// configuration specifies the CRL expiration period in days (the validity period of
/// the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the
/// S3 bucket that is included in certificates issued by the CA. If successful, this action
/// returns the Amazon Resource Name (ARN) of the CA.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting
/// Your CRLs</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority service method.</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 CreateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
public virtual Task<CreateCertificateAuthorityResponse> CreateCertificateAuthorityAsync(CreateCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<CreateCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region CreateCertificateAuthorityAuditReport
/// <summary>
/// Creates an audit report that lists every time that your CA private key is used. The
/// report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// actions use the private key.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting
/// Your Audit Reports</a>.
/// </para>
/// <note>
/// <para>
/// You can generate a maximum of one report every 30 minutes.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport service method.</param>
///
/// <returns>The response from the CreateCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
public virtual CreateCertificateAuthorityAuditReportResponse CreateCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return Invoke<CreateCertificateAuthorityAuditReportResponse>(request, options);
}
/// <summary>
/// Creates an audit report that lists every time that your CA private key is used. The
/// report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// actions use the private key.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting
/// Your Audit Reports</a>.
/// </para>
/// <note>
/// <para>
/// You can generate a maximum of one report every 30 minutes.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport service method.</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 CreateCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
public virtual Task<CreateCertificateAuthorityAuditReportResponse> CreateCertificateAuthorityAuditReportAsync(CreateCertificateAuthorityAuditReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return InvokeAsync<CreateCertificateAuthorityAuditReportResponse>(request, options, cancellationToken);
}
#endregion
#region CreatePermission
/// <summary>
/// Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
/// principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
/// renew ACM certificates that reside in the same Amazon Web Services account as the
/// CA.
///
///
/// <para>
/// You can list current permissions with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action and revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreatePermission service method.</param>
///
/// <returns>The response from the CreatePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.PermissionAlreadyExistsException">
/// The designated permission has already been given to the user.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
public virtual CreatePermissionResponse CreatePermission(CreatePermissionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreatePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreatePermissionResponseUnmarshaller.Instance;
return Invoke<CreatePermissionResponse>(request, options);
}
/// <summary>
/// Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
/// principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
/// renew ACM certificates that reside in the same Amazon Web Services account as the
/// CA.
///
///
/// <para>
/// You can list current permissions with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action and revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreatePermission service method.</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 CreatePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.PermissionAlreadyExistsException">
/// The designated permission has already been given to the user.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
public virtual Task<CreatePermissionResponse> CreatePermissionAsync(CreatePermissionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreatePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreatePermissionResponseUnmarshaller.Instance;
return InvokeAsync<CreatePermissionResponse>(request, options, cancellationToken);
}
#endregion
#region DeleteCertificateAuthority
/// <summary>
/// Deletes a private certificate authority (CA). You must provide the Amazon Resource
/// Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
/// the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// action.
///
/// <note>
/// <para>
/// Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
/// </para>
/// </note>
/// <para>
/// Before you can delete a CA that you have created and activated, you must disable it.
/// To do this, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>.
///
/// </para>
///
/// <para>
/// Additionally, you can delete a CA if you are waiting for it to be created (that is,
/// the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
/// been created but you haven't yet imported the signed certificate into Amazon Web Services
/// Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>).
/// </para>
///
/// <para>
/// When you successfully call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>,
/// the CA's status changes to <code>DELETED</code>. However, the CA won't be permanently
/// deleted until the restoration period has passed. By default, if you do not set the
/// <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for
/// 30 days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// action returns the time remaining in the restoration window of a private CA in the
/// <code>DELETED</code> state. To restore an eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a>
/// action.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority service method.</param>
///
/// <returns>The response from the DeleteCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
public virtual DeleteCertificateAuthorityResponse DeleteCertificateAuthority(DeleteCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<DeleteCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Deletes a private certificate authority (CA). You must provide the Amazon Resource
/// Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
/// the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// action.
///
/// <note>
/// <para>
/// Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
/// </para>
/// </note>
/// <para>
/// Before you can delete a CA that you have created and activated, you must disable it.
/// To do this, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>.
///
/// </para>
///
/// <para>
/// Additionally, you can delete a CA if you are waiting for it to be created (that is,
/// the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
/// been created but you haven't yet imported the signed certificate into Amazon Web Services
/// Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>).
/// </para>
///
/// <para>
/// When you successfully call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>,
/// the CA's status changes to <code>DELETED</code>. However, the CA won't be permanently
/// deleted until the restoration period has passed. By default, if you do not set the
/// <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for
/// 30 days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// action returns the time remaining in the restoration window of a private CA in the
/// <code>DELETED</code> state. To restore an eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a>
/// action.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority service method.</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 DeleteCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
public virtual Task<DeleteCertificateAuthorityResponse> DeleteCertificateAuthorityAsync(DeleteCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<DeleteCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region DeletePermission
/// <summary>
/// Revokes permissions on a private CA granted to the Certificate Manager (ACM) service
/// principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA. If you revoke these permissions, ACM will
/// no longer renew the affected certificates automatically.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePermission service method.</param>
///
/// <returns>The response from the DeletePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
public virtual DeletePermissionResponse DeletePermission(DeletePermissionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePermissionResponseUnmarshaller.Instance;
return Invoke<DeletePermissionResponse>(request, options);
}
/// <summary>
/// Revokes permissions on a private CA granted to the Certificate Manager (ACM) service
/// principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA. If you revoke these permissions, ACM will
/// no longer renew the affected certificates automatically.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePermission service method.</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 DeletePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
public virtual Task<DeletePermissionResponse> DeletePermissionAsync(DeletePermissionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePermissionResponseUnmarshaller.Instance;
return InvokeAsync<DeletePermissionResponse>(request, options, cancellationToken);
}
#endregion
#region DeletePolicy
/// <summary>
/// Deletes the resource-based policy attached to a private CA. Deletion will remove any
/// access that the policy has granted. If there is no policy attached to the private
/// CA, this action will return successful.
///
///
/// <para>
/// If you delete a policy that was applied through Amazon Web Services Resource Access
/// Manager (RAM), the CA will be removed from all shares in which it was included.
/// </para>
///
/// <para>
/// The Certificate Manager Service Linked Role that the policy supports is not affected
/// when you delete the policy.
/// </para>
///
/// <para>
/// The current policy can be shown with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param>
///
/// <returns>The response from the DeletePolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
public virtual DeletePolicyResponse DeletePolicy(DeletePolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePolicyResponseUnmarshaller.Instance;
return Invoke<DeletePolicyResponse>(request, options);
}
/// <summary>
/// Deletes the resource-based policy attached to a private CA. Deletion will remove any
/// access that the policy has granted. If there is no policy attached to the private
/// CA, this action will return successful.
///
///
/// <para>
/// If you delete a policy that was applied through Amazon Web Services Resource Access
/// Manager (RAM), the CA will be removed from all shares in which it was included.
/// </para>
///
/// <para>
/// The Certificate Manager Service Linked Role that the policy supports is not affected
/// when you delete the policy.
/// </para>
///
/// <para>
/// The current policy can be shown with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</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 DeletePolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
public virtual Task<DeletePolicyResponse> DeletePolicyAsync(DeletePolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePolicyResponseUnmarshaller.Instance;
return InvokeAsync<DeletePolicyResponse>(request, options, cancellationToken);
}
#endregion
#region DescribeCertificateAuthority
/// <summary>
/// Lists information about your private certificate authority (CA) or one that has been
/// shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
/// The output contains the status of your CA. This can be any of the following:
///
/// <ul> <li>
/// <para>
/// <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
/// authority.
/// </para>
/// </li> <li>
/// <para>
/// <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your
/// Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign
/// your private CA CSR and then import it into Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>ACTIVE</code> - Your private CA is active.
/// </para>
/// </li> <li>
/// <para>
/// <code>DISABLED</code> - Your private CA has been disabled.
/// </para>
/// </li> <li>
/// <para>
/// <code>EXPIRED</code> - Your private CA certificate has expired.
/// </para>
/// </li> <li>
/// <para>
/// <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems
/// such a network outage or back-end Amazon Web Services failure or other errors. A failed
/// CA can never return to the pending state. You must create a new CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>DELETED</code> - Your private CA is within the restoration period, after which
/// it is permanently deleted. The length of time remaining in the CA's restoration period
/// is also included in this action's output.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority service method.</param>
///
/// <returns>The response from the DescribeCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
public virtual DescribeCertificateAuthorityResponse DescribeCertificateAuthority(DescribeCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<DescribeCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Lists information about your private certificate authority (CA) or one that has been
/// shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
/// The output contains the status of your CA. This can be any of the following:
///
/// <ul> <li>
/// <para>
/// <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
/// authority.
/// </para>
/// </li> <li>
/// <para>
/// <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your
/// Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign
/// your private CA CSR and then import it into Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>ACTIVE</code> - Your private CA is active.
/// </para>
/// </li> <li>
/// <para>
/// <code>DISABLED</code> - Your private CA has been disabled.
/// </para>
/// </li> <li>
/// <para>
/// <code>EXPIRED</code> - Your private CA certificate has expired.
/// </para>
/// </li> <li>
/// <para>
/// <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems
/// such a network outage or back-end Amazon Web Services failure or other errors. A failed
/// CA can never return to the pending state. You must create a new CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>DELETED</code> - Your private CA is within the restoration period, after which
/// it is permanently deleted. The length of time remaining in the CA's restoration period
/// is also included in this action's output.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority service method.</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 DescribeCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
public virtual Task<DescribeCertificateAuthorityResponse> DescribeCertificateAuthorityAsync(DescribeCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<DescribeCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region DescribeCertificateAuthorityAuditReport
/// <summary>
/// Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action. Audit information is created every time the certificate authority (CA) private
/// key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport service method.</param>
///
/// <returns>The response from the DescribeCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
public virtual DescribeCertificateAuthorityAuditReportResponse DescribeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return Invoke<DescribeCertificateAuthorityAuditReportResponse>(request, options);
}
/// <summary>
/// Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action. Audit information is created every time the certificate authority (CA) private
/// key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport service method.</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 DescribeCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
public virtual Task<DescribeCertificateAuthorityAuditReportResponse> DescribeCertificateAuthorityAuditReportAsync(DescribeCertificateAuthorityAuditReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return InvokeAsync<DescribeCertificateAuthorityAuditReportResponse>(request, options, cancellationToken);
}
#endregion
#region GetCertificate
/// <summary>
/// Retrieves a certificate from your private CA or one that has been shared with you.
/// The ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action. You must specify both the ARN of your private CA and the ARN of the issued
/// certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate
/// if it is in the <b>ISSUED</b> state. You can call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action to create a report that contains information about all of the certificates
/// issued and revoked by your private CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificate service method.</param>
///
/// <returns>The response from the GetCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
public virtual GetCertificateResponse GetCertificate(GetCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateResponseUnmarshaller.Instance;
return Invoke<GetCertificateResponse>(request, options);
}
/// <summary>
/// Retrieves a certificate from your private CA or one that has been shared with you.
/// The ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action. You must specify both the ARN of your private CA and the ARN of the issued
/// certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate
/// if it is in the <b>ISSUED</b> state. You can call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action to create a report that contains information about all of the certificates
/// issued and revoked by your private CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificate service method.</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 GetCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
public virtual Task<GetCertificateResponse> GetCertificateAsync(GetCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateResponseUnmarshaller.Instance;
return InvokeAsync<GetCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region GetCertificateAuthorityCertificate
/// <summary>
/// Retrieves the certificate and certificate chain for your private certificate authority
/// (CA) or one that has been shared with you. Both the certificate and the chain are
/// base64 PEM-encoded. The chain does not include the CA certificate. Each certificate
/// in the chain signs the one before it.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate service method.</param>
///
/// <returns>The response from the GetCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
public virtual GetCertificateAuthorityCertificateResponse GetCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return Invoke<GetCertificateAuthorityCertificateResponse>(request, options);
}
/// <summary>
/// Retrieves the certificate and certificate chain for your private certificate authority
/// (CA) or one that has been shared with you. Both the certificate and the chain are
/// base64 PEM-encoded. The chain does not include the CA certificate. Each certificate
/// in the chain signs the one before it.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate service method.</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 GetCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
public virtual Task<GetCertificateAuthorityCertificateResponse> GetCertificateAuthorityCertificateAsync(GetCertificateAuthorityCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return InvokeAsync<GetCertificateAuthorityCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region GetCertificateAuthorityCsr
/// <summary>
/// Retrieves the certificate signing request (CSR) for your private certificate authority
/// (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises
/// root or subordinate CA. Then import the signed certificate back into Amazon Web Services
/// Private CA by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action. The CSR is returned as a base64 PEM-encoded string.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr service method.</param>
///
/// <returns>The response from the GetCertificateAuthorityCsr service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
public virtual GetCertificateAuthorityCsrResponse GetCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCsrRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCsrResponseUnmarshaller.Instance;
return Invoke<GetCertificateAuthorityCsrResponse>(request, options);
}
/// <summary>
/// Retrieves the certificate signing request (CSR) for your private certificate authority
/// (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises
/// root or subordinate CA. Then import the signed certificate back into Amazon Web Services
/// Private CA by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action. The CSR is returned as a base64 PEM-encoded string.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr service method.</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 GetCertificateAuthorityCsr service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
public virtual Task<GetCertificateAuthorityCsrResponse> GetCertificateAuthorityCsrAsync(GetCertificateAuthorityCsrRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCsrRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCsrResponseUnmarshaller.Instance;
return InvokeAsync<GetCertificateAuthorityCsrResponse>(request, options, cancellationToken);
}
#endregion
#region GetPolicy
/// <summary>
/// Retrieves the resource-based policy attached to a private CA. If either the private
/// CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>.
///
///
///
/// <para>
/// The policy can be attached or updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</param>
///
/// <returns>The response from the GetPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
public virtual GetPolicyResponse GetPolicy(GetPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPolicyResponseUnmarshaller.Instance;
return Invoke<GetPolicyResponse>(request, options);
}
/// <summary>
/// Retrieves the resource-based policy attached to a private CA. If either the private
/// CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>.
///
///
///
/// <para>
/// The policy can be attached or updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</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 GetPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
public virtual Task<GetPolicyResponse> GetPolicyAsync(GetPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPolicyResponseUnmarshaller.Instance;
return InvokeAsync<GetPolicyResponse>(request, options, cancellationToken);
}
#endregion
#region ImportCertificateAuthorityCertificate
/// <summary>
/// Imports a signed private CA certificate into Amazon Web Services Private CA. This
/// action is used when you are using a chain of trust whose root is located outside Amazon
/// Web Services Private CA. Before you can call this action, the following preparations
/// must in place:
///
/// <ol> <li>
/// <para>
/// In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action to create the private CA that you plan to back with the imported certificate.
/// </para>
/// </li> <li>
/// <para>
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a>
/// action to generate a certificate signing request (CSR).
/// </para>
/// </li> <li>
/// <para>
/// Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy
/// or by a commercial CA.
/// </para>
/// </li> <li>
/// <para>
/// Create a certificate chain and copy the signed certificate and the certificate chain
/// to your working directory.
/// </para>
/// </li> </ol>
/// <para>
/// Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
/// </para>
/// <ul> <li>
/// <para>
/// Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is hosted by Amazon
/// Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is externally hosted.
/// </para>
/// </li> </ul>
/// <para>
/// The following additional requirements apply when you import a CA certificate.
/// </para>
/// <ul> <li>
/// <para>
/// Only a self-signed certificate can be imported as a root CA.
/// </para>
/// </li> <li>
/// <para>
/// A self-signed certificate cannot be imported as a subordinate CA.
/// </para>
/// </li> <li>
/// <para>
/// Your certificate chain must not include the private CA certificate that you are importing.
/// </para>
/// </li> <li>
/// <para>
/// Your root CA must be the last certificate in your chain. The subordinate certificate,
/// if any, that your root CA signed must be next to last. The subordinate certificate
/// signed by the preceding subordinate CA must come next, and so on until your chain
/// is built.
/// </para>
/// </li> <li>
/// <para>
/// The chain must be PEM-encoded.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate is 32 KB.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate chain is 2 MB.
/// </para>
/// </li> </ul>
/// <para>
/// <i>Enforcement of Critical Constraints</i>
/// </para>
///
/// <para>
/// Amazon Web Services Private CA allows the following extensions to be marked critical
/// in the imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Basic constraints (<i>must</i> be marked critical)
/// </para>
/// </li> <li>
/// <para>
/// Subject alternative names
/// </para>
/// </li> <li>
/// <para>
/// Key usage
/// </para>
/// </li> <li>
/// <para>
/// Extended key usage
/// </para>
/// </li> <li>
/// <para>
/// Authority key identifier
/// </para>
/// </li> <li>
/// <para>
/// Subject key identifier
/// </para>
/// </li> <li>
/// <para>
/// Issuer alternative name
/// </para>
/// </li> <li>
/// <para>
/// Subject directory attributes
/// </para>
/// </li> <li>
/// <para>
/// Subject information access
/// </para>
/// </li> <li>
/// <para>
/// Certificate policies
/// </para>
/// </li> <li>
/// <para>
/// Policy mappings
/// </para>
/// </li> <li>
/// <para>
/// Inhibit anyPolicy
/// </para>
/// </li> </ul>
/// <para>
/// Amazon Web Services Private CA rejects the following extensions when they are marked
/// critical in an imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Name constraints
/// </para>
/// </li> <li>
/// <para>
/// Policy constraints
/// </para>
/// </li> <li>
/// <para>
/// CRL distribution points
/// </para>
/// </li> <li>
/// <para>
/// Authority information access
/// </para>
/// </li> <li>
/// <para>
/// Freshest CRL
/// </para>
/// </li> <li>
/// <para>
/// Any other extension
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate service method.</param>
///
/// <returns>The response from the ImportCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.CertificateMismatchException">
/// The certificate authority certificate you are importing does not comply with conditions
/// specified in the certificate that signed it.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCertificateException">
/// One or more fields in the certificate are invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
public virtual ImportCertificateAuthorityCertificateResponse ImportCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ImportCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = ImportCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return Invoke<ImportCertificateAuthorityCertificateResponse>(request, options);
}
/// <summary>
/// Imports a signed private CA certificate into Amazon Web Services Private CA. This
/// action is used when you are using a chain of trust whose root is located outside Amazon
/// Web Services Private CA. Before you can call this action, the following preparations
/// must in place:
///
/// <ol> <li>
/// <para>
/// In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action to create the private CA that you plan to back with the imported certificate.
/// </para>
/// </li> <li>
/// <para>
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a>
/// action to generate a certificate signing request (CSR).
/// </para>
/// </li> <li>
/// <para>
/// Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy
/// or by a commercial CA.
/// </para>
/// </li> <li>
/// <para>
/// Create a certificate chain and copy the signed certificate and the certificate chain
/// to your working directory.
/// </para>
/// </li> </ol>
/// <para>
/// Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
/// </para>
/// <ul> <li>
/// <para>
/// Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is hosted by Amazon
/// Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is externally hosted.
/// </para>
/// </li> </ul>
/// <para>
/// The following additional requirements apply when you import a CA certificate.
/// </para>
/// <ul> <li>
/// <para>
/// Only a self-signed certificate can be imported as a root CA.
/// </para>
/// </li> <li>
/// <para>
/// A self-signed certificate cannot be imported as a subordinate CA.
/// </para>
/// </li> <li>
/// <para>
/// Your certificate chain must not include the private CA certificate that you are importing.
/// </para>
/// </li> <li>
/// <para>
/// Your root CA must be the last certificate in your chain. The subordinate certificate,
/// if any, that your root CA signed must be next to last. The subordinate certificate
/// signed by the preceding subordinate CA must come next, and so on until your chain
/// is built.
/// </para>
/// </li> <li>
/// <para>
/// The chain must be PEM-encoded.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate is 32 KB.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate chain is 2 MB.
/// </para>
/// </li> </ul>
/// <para>
/// <i>Enforcement of Critical Constraints</i>
/// </para>
///
/// <para>
/// Amazon Web Services Private CA allows the following extensions to be marked critical
/// in the imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Basic constraints (<i>must</i> be marked critical)
/// </para>
/// </li> <li>
/// <para>
/// Subject alternative names
/// </para>
/// </li> <li>
/// <para>
/// Key usage
/// </para>
/// </li> <li>
/// <para>
/// Extended key usage
/// </para>
/// </li> <li>
/// <para>
/// Authority key identifier
/// </para>
/// </li> <li>
/// <para>
/// Subject key identifier
/// </para>
/// </li> <li>
/// <para>
/// Issuer alternative name
/// </para>
/// </li> <li>
/// <para>
/// Subject directory attributes
/// </para>
/// </li> <li>
/// <para>
/// Subject information access
/// </para>
/// </li> <li>
/// <para>
/// Certificate policies
/// </para>
/// </li> <li>
/// <para>
/// Policy mappings
/// </para>
/// </li> <li>
/// <para>
/// Inhibit anyPolicy
/// </para>
/// </li> </ul>
/// <para>
/// Amazon Web Services Private CA rejects the following extensions when they are marked
/// critical in an imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Name constraints
/// </para>
/// </li> <li>
/// <para>
/// Policy constraints
/// </para>
/// </li> <li>
/// <para>
/// CRL distribution points
/// </para>
/// </li> <li>
/// <para>
/// Authority information access
/// </para>
/// </li> <li>
/// <para>
/// Freshest CRL
/// </para>
/// </li> <li>
/// <para>
/// Any other extension
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate service method.</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 ImportCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.CertificateMismatchException">
/// The certificate authority certificate you are importing does not comply with conditions
/// specified in the certificate that signed it.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCertificateException">
/// One or more fields in the certificate are invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
public virtual Task<ImportCertificateAuthorityCertificateResponse> ImportCertificateAuthorityCertificateAsync(ImportCertificateAuthorityCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ImportCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = ImportCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return InvokeAsync<ImportCertificateAuthorityCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region IssueCertificate
/// <summary>
/// Uses your private certificate authority (CA), or one that has been shared with you,
/// to issue a client certificate. This action returns the Amazon Resource Name (ARN)
/// of the certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a>
/// action and specifying the ARN.
///
/// <note>
/// <para>
/// You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs
/// of the certificates that you issue by using Amazon Web Services Private CA.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate service method.</param>
///
/// <returns>The response from the IssueCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCSRException">
/// The certificate signing request is invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
public virtual IssueCertificateResponse IssueCertificate(IssueCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = IssueCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = IssueCertificateResponseUnmarshaller.Instance;
return Invoke<IssueCertificateResponse>(request, options);
}
/// <summary>
/// Uses your private certificate authority (CA), or one that has been shared with you,
/// to issue a client certificate. This action returns the Amazon Resource Name (ARN)
/// of the certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a>
/// action and specifying the ARN.
///
/// <note>
/// <para>
/// You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs
/// of the certificates that you issue by using Amazon Web Services Private CA.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate service method.</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 IssueCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCSRException">
/// The certificate signing request is invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
public virtual Task<IssueCertificateResponse> IssueCertificateAsync(IssueCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = IssueCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = IssueCertificateResponseUnmarshaller.Instance;
return InvokeAsync<IssueCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region ListCertificateAuthorities
/// <summary>
/// Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities service method.</param>
///
/// <returns>The response from the ListCertificateAuthorities service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
public virtual ListCertificateAuthoritiesResponse ListCertificateAuthorities(ListCertificateAuthoritiesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCertificateAuthoritiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCertificateAuthoritiesResponseUnmarshaller.Instance;
return Invoke<ListCertificateAuthoritiesResponse>(request, options);
}
/// <summary>
/// Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities service method.</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 ListCertificateAuthorities service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
public virtual Task<ListCertificateAuthoritiesResponse> ListCertificateAuthoritiesAsync(ListCertificateAuthoritiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCertificateAuthoritiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCertificateAuthoritiesResponseUnmarshaller.Instance;
return InvokeAsync<ListCertificateAuthoritiesResponse>(request, options, cancellationToken);
}
#endregion
#region ListPermissions
/// <summary>
/// List all permissions on a private CA, if any, granted to the Certificate Manager (ACM)
/// service principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListPermissions service method.</param>
///
/// <returns>The response from the ListPermissions service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
public virtual ListPermissionsResponse ListPermissions(ListPermissionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPermissionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPermissionsResponseUnmarshaller.Instance;
return Invoke<ListPermissionsResponse>(request, options);
}
/// <summary>
/// List all permissions on a private CA, if any, granted to the Certificate Manager (ACM)
/// service principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListPermissions service method.</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 ListPermissions service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
public virtual Task<ListPermissionsResponse> ListPermissionsAsync(ListPermissionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPermissionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPermissionsResponseUnmarshaller.Instance;
return InvokeAsync<ListPermissionsResponse>(request, options, cancellationToken);
}
#endregion
#region ListTags
/// <summary>
/// Lists the tags, if any, that are associated with your private CA or one that has been
/// shared with you. Tags are labels that you can use to identify and organize your CAs.
/// Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
/// action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action to remove tags.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListTags service method.</param>
///
/// <returns>The response from the ListTags service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
public virtual ListTagsResponse ListTags(ListTagsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsResponseUnmarshaller.Instance;
return Invoke<ListTagsResponse>(request, options);
}
/// <summary>
/// Lists the tags, if any, that are associated with your private CA or one that has been
/// shared with you. Tags are labels that you can use to identify and organize your CAs.
/// Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
/// action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action to remove tags.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListTags service method.</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 ListTags service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
public virtual Task<ListTagsResponse> ListTagsAsync(ListTagsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsResponseUnmarshaller.Instance;
return InvokeAsync<ListTagsResponse>(request, options, cancellationToken);
}
#endregion
#region PutPolicy
/// <summary>
/// Attaches a resource-based policy to a private CA.
///
///
/// <para>
/// A policy can also be applied by sharing a private CA through Amazon Web Services Resource
/// Access Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
///
/// <para>
/// The policy can be displayed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the PutPolicy service method.</param>
///
/// <returns>The response from the PutPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
public virtual PutPolicyResponse PutPolicy(PutPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutPolicyResponseUnmarshaller.Instance;
return Invoke<PutPolicyResponse>(request, options);
}
/// <summary>
/// Attaches a resource-based policy to a private CA.
///
///
/// <para>
/// A policy can also be applied by sharing a private CA through Amazon Web Services Resource
/// Access Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
///
/// <para>
/// The policy can be displayed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the PutPolicy service method.</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 PutPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
public virtual Task<PutPolicyResponse> PutPolicyAsync(PutPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutPolicyResponseUnmarshaller.Instance;
return InvokeAsync<PutPolicyResponse>(request, options, cancellationToken);
}
#endregion
#region RestoreCertificateAuthority
/// <summary>
/// Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
/// can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b>
/// parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>
/// action. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b>
/// value, by default you can restore the CA at any time in a 30 day period. You can check
/// the time remaining in the restoration period of a private CA in the <code>DELETED</code>
/// state by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// or <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// actions. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b>
/// action returns. To change its status to <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion,
/// you must use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action to import a certificate authority into the private CA before it can be activated.
/// You cannot restore a CA after the restoration period has ended.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority service method.</param>
///
/// <returns>The response from the RestoreCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
public virtual RestoreCertificateAuthorityResponse RestoreCertificateAuthority(RestoreCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<RestoreCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
/// can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b>
/// parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>
/// action. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b>
/// value, by default you can restore the CA at any time in a 30 day period. You can check
/// the time remaining in the restoration period of a private CA in the <code>DELETED</code>
/// state by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// or <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// actions. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b>
/// action returns. To change its status to <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion,
/// you must use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action to import a certificate authority into the private CA before it can be activated.
/// You cannot restore a CA after the restoration period has ended.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority service method.</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 RestoreCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
public virtual Task<RestoreCertificateAuthorityResponse> RestoreCertificateAuthorityAsync(RestoreCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<RestoreCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region RevokeCertificate
/// <summary>
/// Revokes a certificate that was issued inside Amazon Web Services Private CA. If you
/// enable a certificate revocation list (CRL) when you create or update your private
/// CA, information about the revoked certificates will be included in the CRL. Amazon
/// Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is
/// typically updated approximately 30 minutes after a certificate is revoked. If for
/// any reason the CRL update fails, Amazon Web Services Private CA attempts makes further
/// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
/// <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information,
/// see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported
/// CloudWatch Metrics</a>.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA also writes revocation information to the audit report.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.
/// </para>
/// <note>
/// <para>
/// You cannot revoke a root CA self-signed certificate.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate service method.</param>
///
/// <returns>The response from the RevokeCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestAlreadyProcessedException">
/// Your request has already been completed.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
public virtual RevokeCertificateResponse RevokeCertificate(RevokeCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RevokeCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = RevokeCertificateResponseUnmarshaller.Instance;
return Invoke<RevokeCertificateResponse>(request, options);
}
/// <summary>
/// Revokes a certificate that was issued inside Amazon Web Services Private CA. If you
/// enable a certificate revocation list (CRL) when you create or update your private
/// CA, information about the revoked certificates will be included in the CRL. Amazon
/// Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is
/// typically updated approximately 30 minutes after a certificate is revoked. If for
/// any reason the CRL update fails, Amazon Web Services Private CA attempts makes further
/// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
/// <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information,
/// see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported
/// CloudWatch Metrics</a>.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA also writes revocation information to the audit report.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.
/// </para>
/// <note>
/// <para>
/// You cannot revoke a root CA self-signed certificate.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate service method.</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 RevokeCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestAlreadyProcessedException">
/// Your request has already been completed.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
public virtual Task<RevokeCertificateResponse> RevokeCertificateAsync(RevokeCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RevokeCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = RevokeCertificateResponseUnmarshaller.Instance;
return InvokeAsync<RevokeCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region TagCertificateAuthority
/// <summary>
/// Adds one or more tags to your private CA. Tags are labels that you can use to identify
/// and organize your Amazon Web Services resources. Each tag consists of a key and an
/// optional value. You specify the private CA on input by its Amazon Resource Name (ARN).
/// You specify the tag by using a key-value pair. You can apply a tag to just one private
/// CA if you want to identify a specific characteristic of that CA, or you can apply
/// the same tag to multiple private CAs if you want to filter for a common relationship
/// among those CAs. To remove one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
///
/// <note>
/// <para>
/// To attach tags to a private CA during the creation procedure, a CA administrator must
/// first associate an inline IAM policy with the <code>CreateCertificateAuthority</code>
/// action and explicitly allow tagging. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching
/// tags to a CA at the time of creation</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority service method.</param>
///
/// <returns>The response from the TagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.TooManyTagsException">
/// You can associate up to 50 tags with a private CA. Exception information is contained
/// in the exception message field.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
public virtual TagCertificateAuthorityResponse TagCertificateAuthority(TagCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<TagCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Adds one or more tags to your private CA. Tags are labels that you can use to identify
/// and organize your Amazon Web Services resources. Each tag consists of a key and an
/// optional value. You specify the private CA on input by its Amazon Resource Name (ARN).
/// You specify the tag by using a key-value pair. You can apply a tag to just one private
/// CA if you want to identify a specific characteristic of that CA, or you can apply
/// the same tag to multiple private CAs if you want to filter for a common relationship
/// among those CAs. To remove one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
///
/// <note>
/// <para>
/// To attach tags to a private CA during the creation procedure, a CA administrator must
/// first associate an inline IAM policy with the <code>CreateCertificateAuthority</code>
/// action and explicitly allow tagging. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching
/// tags to a CA at the time of creation</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority service method.</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 TagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.TooManyTagsException">
/// You can associate up to 50 tags with a private CA. Exception information is contained
/// in the exception message field.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
public virtual Task<TagCertificateAuthorityResponse> TagCertificateAuthorityAsync(TagCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = TagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<TagCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region UntagCertificateAuthority
/// <summary>
/// Remove one or more tags from your private CA. A tag consists of a key-value pair.
/// If you do not specify the value portion of the tag when calling this action, the tag
/// will be removed regardless of value. If you specify a value, the tag is removed only
/// if it is associated with the specified value. To add tags to a private CA, use the
/// <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>.
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority service method.</param>
///
/// <returns>The response from the UntagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
public virtual UntagCertificateAuthorityResponse UntagCertificateAuthority(UntagCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<UntagCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Remove one or more tags from your private CA. A tag consists of a key-value pair.
/// If you do not specify the value portion of the tag when calling this action, the tag
/// will be removed regardless of value. If you specify a value, the tag is removed only
/// if it is associated with the specified value. To add tags to a private CA, use the
/// <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>.
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority service method.</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 UntagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
public virtual Task<UntagCertificateAuthorityResponse> UntagCertificateAuthorityAsync(UntagCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<UntagCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region UpdateCertificateAuthority
/// <summary>
/// Updates the status or configuration of a private certificate authority (CA). Your
/// private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before
/// you can update it. You can disable a private CA that is in the <code>ACTIVE</code>
/// state or make a CA that is in the <code>DISABLED</code> state active again.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority service method.</param>
///
/// <returns>The response from the UpdateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
public virtual UpdateCertificateAuthorityResponse UpdateCertificateAuthority(UpdateCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<UpdateCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Updates the status or configuration of a private certificate authority (CA). Your
/// private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before
/// you can update it. You can disable a private CA that is in the <code>ACTIVE</code>
/// state or make a CA that is in the <code>DISABLED</code> state active again.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority service method.</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 UpdateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
public virtual Task<UpdateCertificateAuthorityResponse> UpdateCertificateAuthorityAsync(UpdateCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<UpdateCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
}
} | 3,230 |
aws-sdk-net | aws | C# | /*
* 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 acm-pca-2017-08-22.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.ACMPCA.Model;
namespace Amazon.ACMPCA
{
/// <summary>
/// Interface for accessing ACMPCA
///
/// This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>.
/// It provides descriptions, syntax, and usage examples for each of the actions and data
/// types involved in creating and managing a private certificate authority (CA) for your
/// organization.
///
///
/// <para>
/// The documentation for each action shows the API request parameters and the JSON response.
/// Alternatively, you can use one of the Amazon Web Services SDKs to access an API that
/// is tailored to the programming language or platform that you prefer. For more information,
/// see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.
/// </para>
///
/// <para>
/// Each Amazon Web Services Private CA API operation has a quota that determines the
/// number of times the operation can be called per second. Amazon Web Services Private
/// CA throttles API requests at different rates depending on the operation. Throttling
/// means that Amazon Web Services Private CA rejects an otherwise valid request because
/// the request exceeds the operation's quota for the number of requests per second. When
/// a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a>
/// error. Amazon Web Services Private CA does not guarantee a minimum request rate for
/// APIs.
/// </para>
///
/// <para>
/// To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request
/// a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service
/// Quotas</a> console.
/// </para>
/// </summary>
public partial interface IAmazonACMPCA : IAmazonService, IDisposable
{
/// <summary>
/// Paginators for the service
/// </summary>
IACMPCAPaginatorFactory Paginators { get; }
#region CreateCertificateAuthority
/// <summary>
/// Creates a root or subordinate private certificate authority (CA). You must specify
/// the CA configuration, an optional configuration for Online Certificate Status Protocol
/// (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency
/// token to avoid accidental creation of multiple CAs. The CA configuration specifies
/// the name of the algorithm and key size to be used to create the CA private key, the
/// type of signing algorithm that the CA uses, and X.500 subject information. The OCSP
/// configuration can optionally specify a custom URL for the OCSP responder. The CRL
/// configuration specifies the CRL expiration period in days (the validity period of
/// the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the
/// S3 bucket that is included in certificates issued by the CA. If successful, this action
/// returns the Amazon Resource Name (ARN) of the CA.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting
/// Your CRLs</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority service method.</param>
///
/// <returns>The response from the CreateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
CreateCertificateAuthorityResponse CreateCertificateAuthority(CreateCertificateAuthorityRequest request);
/// <summary>
/// Creates a root or subordinate private certificate authority (CA). You must specify
/// the CA configuration, an optional configuration for Online Certificate Status Protocol
/// (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency
/// token to avoid accidental creation of multiple CAs. The CA configuration specifies
/// the name of the algorithm and key size to be used to create the CA private key, the
/// type of signing algorithm that the CA uses, and X.500 subject information. The OCSP
/// configuration can optionally specify a custom URL for the OCSP responder. The CRL
/// configuration specifies the CRL expiration period in days (the validity period of
/// the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the
/// S3 bucket that is included in certificates issued by the CA. If successful, this action
/// returns the Amazon Resource Name (ARN) of the CA.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting
/// Your CRLs</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority service method.</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 CreateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
Task<CreateCertificateAuthorityResponse> CreateCertificateAuthorityAsync(CreateCertificateAuthorityRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateCertificateAuthorityAuditReport
/// <summary>
/// Creates an audit report that lists every time that your CA private key is used. The
/// report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// actions use the private key.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting
/// Your Audit Reports</a>.
/// </para>
/// <note>
/// <para>
/// You can generate a maximum of one report every 30 minutes.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport service method.</param>
///
/// <returns>The response from the CreateCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
CreateCertificateAuthorityAuditReportResponse CreateCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest request);
/// <summary>
/// Creates an audit report that lists every time that your CA private key is used. The
/// report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// actions use the private key.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting
/// Your Audit Reports</a>.
/// </para>
/// <note>
/// <para>
/// You can generate a maximum of one report every 30 minutes.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport service method.</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 CreateCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
Task<CreateCertificateAuthorityAuditReportResponse> CreateCertificateAuthorityAuditReportAsync(CreateCertificateAuthorityAuditReportRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreatePermission
/// <summary>
/// Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
/// principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
/// renew ACM certificates that reside in the same Amazon Web Services account as the
/// CA.
///
///
/// <para>
/// You can list current permissions with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action and revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreatePermission service method.</param>
///
/// <returns>The response from the CreatePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.PermissionAlreadyExistsException">
/// The designated permission has already been given to the user.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
CreatePermissionResponse CreatePermission(CreatePermissionRequest request);
/// <summary>
/// Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
/// principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
/// renew ACM certificates that reside in the same Amazon Web Services account as the
/// CA.
///
///
/// <para>
/// You can list current permissions with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action and revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreatePermission service method.</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 CreatePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.PermissionAlreadyExistsException">
/// The designated permission has already been given to the user.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
Task<CreatePermissionResponse> CreatePermissionAsync(CreatePermissionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteCertificateAuthority
/// <summary>
/// Deletes a private certificate authority (CA). You must provide the Amazon Resource
/// Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
/// the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// action.
///
/// <note>
/// <para>
/// Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
/// </para>
/// </note>
/// <para>
/// Before you can delete a CA that you have created and activated, you must disable it.
/// To do this, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>.
///
/// </para>
///
/// <para>
/// Additionally, you can delete a CA if you are waiting for it to be created (that is,
/// the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
/// been created but you haven't yet imported the signed certificate into Amazon Web Services
/// Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>).
/// </para>
///
/// <para>
/// When you successfully call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>,
/// the CA's status changes to <code>DELETED</code>. However, the CA won't be permanently
/// deleted until the restoration period has passed. By default, if you do not set the
/// <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for
/// 30 days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// action returns the time remaining in the restoration window of a private CA in the
/// <code>DELETED</code> state. To restore an eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a>
/// action.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority service method.</param>
///
/// <returns>The response from the DeleteCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
DeleteCertificateAuthorityResponse DeleteCertificateAuthority(DeleteCertificateAuthorityRequest request);
/// <summary>
/// Deletes a private certificate authority (CA). You must provide the Amazon Resource
/// Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
/// the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// action.
///
/// <note>
/// <para>
/// Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
/// </para>
/// </note>
/// <para>
/// Before you can delete a CA that you have created and activated, you must disable it.
/// To do this, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>.
///
/// </para>
///
/// <para>
/// Additionally, you can delete a CA if you are waiting for it to be created (that is,
/// the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
/// been created but you haven't yet imported the signed certificate into Amazon Web Services
/// Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>).
/// </para>
///
/// <para>
/// When you successfully call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>,
/// the CA's status changes to <code>DELETED</code>. However, the CA won't be permanently
/// deleted until the restoration period has passed. By default, if you do not set the
/// <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for
/// 30 days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// action returns the time remaining in the restoration window of a private CA in the
/// <code>DELETED</code> state. To restore an eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a>
/// action.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority service method.</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 DeleteCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
Task<DeleteCertificateAuthorityResponse> DeleteCertificateAuthorityAsync(DeleteCertificateAuthorityRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeletePermission
/// <summary>
/// Revokes permissions on a private CA granted to the Certificate Manager (ACM) service
/// principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA. If you revoke these permissions, ACM will
/// no longer renew the affected certificates automatically.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePermission service method.</param>
///
/// <returns>The response from the DeletePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
DeletePermissionResponse DeletePermission(DeletePermissionRequest request);
/// <summary>
/// Revokes permissions on a private CA granted to the Certificate Manager (ACM) service
/// principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA. If you revoke these permissions, ACM will
/// no longer renew the affected certificates automatically.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePermission service method.</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 DeletePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
Task<DeletePermissionResponse> DeletePermissionAsync(DeletePermissionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeletePolicy
/// <summary>
/// Deletes the resource-based policy attached to a private CA. Deletion will remove any
/// access that the policy has granted. If there is no policy attached to the private
/// CA, this action will return successful.
///
///
/// <para>
/// If you delete a policy that was applied through Amazon Web Services Resource Access
/// Manager (RAM), the CA will be removed from all shares in which it was included.
/// </para>
///
/// <para>
/// The Certificate Manager Service Linked Role that the policy supports is not affected
/// when you delete the policy.
/// </para>
///
/// <para>
/// The current policy can be shown with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param>
///
/// <returns>The response from the DeletePolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
DeletePolicyResponse DeletePolicy(DeletePolicyRequest request);
/// <summary>
/// Deletes the resource-based policy attached to a private CA. Deletion will remove any
/// access that the policy has granted. If there is no policy attached to the private
/// CA, this action will return successful.
///
///
/// <para>
/// If you delete a policy that was applied through Amazon Web Services Resource Access
/// Manager (RAM), the CA will be removed from all shares in which it was included.
/// </para>
///
/// <para>
/// The Certificate Manager Service Linked Role that the policy supports is not affected
/// when you delete the policy.
/// </para>
///
/// <para>
/// The current policy can be shown with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</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 DeletePolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
Task<DeletePolicyResponse> DeletePolicyAsync(DeletePolicyRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeCertificateAuthority
/// <summary>
/// Lists information about your private certificate authority (CA) or one that has been
/// shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
/// The output contains the status of your CA. This can be any of the following:
///
/// <ul> <li>
/// <para>
/// <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
/// authority.
/// </para>
/// </li> <li>
/// <para>
/// <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your
/// Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign
/// your private CA CSR and then import it into Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>ACTIVE</code> - Your private CA is active.
/// </para>
/// </li> <li>
/// <para>
/// <code>DISABLED</code> - Your private CA has been disabled.
/// </para>
/// </li> <li>
/// <para>
/// <code>EXPIRED</code> - Your private CA certificate has expired.
/// </para>
/// </li> <li>
/// <para>
/// <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems
/// such a network outage or back-end Amazon Web Services failure or other errors. A failed
/// CA can never return to the pending state. You must create a new CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>DELETED</code> - Your private CA is within the restoration period, after which
/// it is permanently deleted. The length of time remaining in the CA's restoration period
/// is also included in this action's output.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority service method.</param>
///
/// <returns>The response from the DescribeCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
DescribeCertificateAuthorityResponse DescribeCertificateAuthority(DescribeCertificateAuthorityRequest request);
/// <summary>
/// Lists information about your private certificate authority (CA) or one that has been
/// shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
/// The output contains the status of your CA. This can be any of the following:
///
/// <ul> <li>
/// <para>
/// <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
/// authority.
/// </para>
/// </li> <li>
/// <para>
/// <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your
/// Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign
/// your private CA CSR and then import it into Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>ACTIVE</code> - Your private CA is active.
/// </para>
/// </li> <li>
/// <para>
/// <code>DISABLED</code> - Your private CA has been disabled.
/// </para>
/// </li> <li>
/// <para>
/// <code>EXPIRED</code> - Your private CA certificate has expired.
/// </para>
/// </li> <li>
/// <para>
/// <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems
/// such a network outage or back-end Amazon Web Services failure or other errors. A failed
/// CA can never return to the pending state. You must create a new CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>DELETED</code> - Your private CA is within the restoration period, after which
/// it is permanently deleted. The length of time remaining in the CA's restoration period
/// is also included in this action's output.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority service method.</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 DescribeCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
Task<DescribeCertificateAuthorityResponse> DescribeCertificateAuthorityAsync(DescribeCertificateAuthorityRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeCertificateAuthorityAuditReport
/// <summary>
/// Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action. Audit information is created every time the certificate authority (CA) private
/// key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport service method.</param>
///
/// <returns>The response from the DescribeCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
DescribeCertificateAuthorityAuditReportResponse DescribeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest request);
/// <summary>
/// Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action. Audit information is created every time the certificate authority (CA) private
/// key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport service method.</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 DescribeCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
Task<DescribeCertificateAuthorityAuditReportResponse> DescribeCertificateAuthorityAuditReportAsync(DescribeCertificateAuthorityAuditReportRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetCertificate
/// <summary>
/// Retrieves a certificate from your private CA or one that has been shared with you.
/// The ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action. You must specify both the ARN of your private CA and the ARN of the issued
/// certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate
/// if it is in the <b>ISSUED</b> state. You can call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action to create a report that contains information about all of the certificates
/// issued and revoked by your private CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificate service method.</param>
///
/// <returns>The response from the GetCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
GetCertificateResponse GetCertificate(GetCertificateRequest request);
/// <summary>
/// Retrieves a certificate from your private CA or one that has been shared with you.
/// The ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action. You must specify both the ARN of your private CA and the ARN of the issued
/// certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate
/// if it is in the <b>ISSUED</b> state. You can call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action to create a report that contains information about all of the certificates
/// issued and revoked by your private CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificate service method.</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 GetCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
Task<GetCertificateResponse> GetCertificateAsync(GetCertificateRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetCertificateAuthorityCertificate
/// <summary>
/// Retrieves the certificate and certificate chain for your private certificate authority
/// (CA) or one that has been shared with you. Both the certificate and the chain are
/// base64 PEM-encoded. The chain does not include the CA certificate. Each certificate
/// in the chain signs the one before it.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate service method.</param>
///
/// <returns>The response from the GetCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
GetCertificateAuthorityCertificateResponse GetCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest request);
/// <summary>
/// Retrieves the certificate and certificate chain for your private certificate authority
/// (CA) or one that has been shared with you. Both the certificate and the chain are
/// base64 PEM-encoded. The chain does not include the CA certificate. Each certificate
/// in the chain signs the one before it.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate service method.</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 GetCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
Task<GetCertificateAuthorityCertificateResponse> GetCertificateAuthorityCertificateAsync(GetCertificateAuthorityCertificateRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetCertificateAuthorityCsr
/// <summary>
/// Retrieves the certificate signing request (CSR) for your private certificate authority
/// (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises
/// root or subordinate CA. Then import the signed certificate back into Amazon Web Services
/// Private CA by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action. The CSR is returned as a base64 PEM-encoded string.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr service method.</param>
///
/// <returns>The response from the GetCertificateAuthorityCsr service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
GetCertificateAuthorityCsrResponse GetCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest request);
/// <summary>
/// Retrieves the certificate signing request (CSR) for your private certificate authority
/// (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises
/// root or subordinate CA. Then import the signed certificate back into Amazon Web Services
/// Private CA by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action. The CSR is returned as a base64 PEM-encoded string.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr service method.</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 GetCertificateAuthorityCsr service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
Task<GetCertificateAuthorityCsrResponse> GetCertificateAuthorityCsrAsync(GetCertificateAuthorityCsrRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetPolicy
/// <summary>
/// Retrieves the resource-based policy attached to a private CA. If either the private
/// CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>.
///
///
///
/// <para>
/// The policy can be attached or updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</param>
///
/// <returns>The response from the GetPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
GetPolicyResponse GetPolicy(GetPolicyRequest request);
/// <summary>
/// Retrieves the resource-based policy attached to a private CA. If either the private
/// CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>.
///
///
///
/// <para>
/// The policy can be attached or updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</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 GetPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
Task<GetPolicyResponse> GetPolicyAsync(GetPolicyRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ImportCertificateAuthorityCertificate
/// <summary>
/// Imports a signed private CA certificate into Amazon Web Services Private CA. This
/// action is used when you are using a chain of trust whose root is located outside Amazon
/// Web Services Private CA. Before you can call this action, the following preparations
/// must in place:
///
/// <ol> <li>
/// <para>
/// In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action to create the private CA that you plan to back with the imported certificate.
/// </para>
/// </li> <li>
/// <para>
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a>
/// action to generate a certificate signing request (CSR).
/// </para>
/// </li> <li>
/// <para>
/// Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy
/// or by a commercial CA.
/// </para>
/// </li> <li>
/// <para>
/// Create a certificate chain and copy the signed certificate and the certificate chain
/// to your working directory.
/// </para>
/// </li> </ol>
/// <para>
/// Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
/// </para>
/// <ul> <li>
/// <para>
/// Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is hosted by Amazon
/// Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is externally hosted.
/// </para>
/// </li> </ul>
/// <para>
/// The following additional requirements apply when you import a CA certificate.
/// </para>
/// <ul> <li>
/// <para>
/// Only a self-signed certificate can be imported as a root CA.
/// </para>
/// </li> <li>
/// <para>
/// A self-signed certificate cannot be imported as a subordinate CA.
/// </para>
/// </li> <li>
/// <para>
/// Your certificate chain must not include the private CA certificate that you are importing.
/// </para>
/// </li> <li>
/// <para>
/// Your root CA must be the last certificate in your chain. The subordinate certificate,
/// if any, that your root CA signed must be next to last. The subordinate certificate
/// signed by the preceding subordinate CA must come next, and so on until your chain
/// is built.
/// </para>
/// </li> <li>
/// <para>
/// The chain must be PEM-encoded.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate is 32 KB.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate chain is 2 MB.
/// </para>
/// </li> </ul>
/// <para>
/// <i>Enforcement of Critical Constraints</i>
/// </para>
///
/// <para>
/// Amazon Web Services Private CA allows the following extensions to be marked critical
/// in the imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Basic constraints (<i>must</i> be marked critical)
/// </para>
/// </li> <li>
/// <para>
/// Subject alternative names
/// </para>
/// </li> <li>
/// <para>
/// Key usage
/// </para>
/// </li> <li>
/// <para>
/// Extended key usage
/// </para>
/// </li> <li>
/// <para>
/// Authority key identifier
/// </para>
/// </li> <li>
/// <para>
/// Subject key identifier
/// </para>
/// </li> <li>
/// <para>
/// Issuer alternative name
/// </para>
/// </li> <li>
/// <para>
/// Subject directory attributes
/// </para>
/// </li> <li>
/// <para>
/// Subject information access
/// </para>
/// </li> <li>
/// <para>
/// Certificate policies
/// </para>
/// </li> <li>
/// <para>
/// Policy mappings
/// </para>
/// </li> <li>
/// <para>
/// Inhibit anyPolicy
/// </para>
/// </li> </ul>
/// <para>
/// Amazon Web Services Private CA rejects the following extensions when they are marked
/// critical in an imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Name constraints
/// </para>
/// </li> <li>
/// <para>
/// Policy constraints
/// </para>
/// </li> <li>
/// <para>
/// CRL distribution points
/// </para>
/// </li> <li>
/// <para>
/// Authority information access
/// </para>
/// </li> <li>
/// <para>
/// Freshest CRL
/// </para>
/// </li> <li>
/// <para>
/// Any other extension
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate service method.</param>
///
/// <returns>The response from the ImportCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.CertificateMismatchException">
/// The certificate authority certificate you are importing does not comply with conditions
/// specified in the certificate that signed it.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCertificateException">
/// One or more fields in the certificate are invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
ImportCertificateAuthorityCertificateResponse ImportCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest request);
/// <summary>
/// Imports a signed private CA certificate into Amazon Web Services Private CA. This
/// action is used when you are using a chain of trust whose root is located outside Amazon
/// Web Services Private CA. Before you can call this action, the following preparations
/// must in place:
///
/// <ol> <li>
/// <para>
/// In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action to create the private CA that you plan to back with the imported certificate.
/// </para>
/// </li> <li>
/// <para>
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a>
/// action to generate a certificate signing request (CSR).
/// </para>
/// </li> <li>
/// <para>
/// Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy
/// or by a commercial CA.
/// </para>
/// </li> <li>
/// <para>
/// Create a certificate chain and copy the signed certificate and the certificate chain
/// to your working directory.
/// </para>
/// </li> </ol>
/// <para>
/// Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
/// </para>
/// <ul> <li>
/// <para>
/// Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is hosted by Amazon
/// Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is externally hosted.
/// </para>
/// </li> </ul>
/// <para>
/// The following additional requirements apply when you import a CA certificate.
/// </para>
/// <ul> <li>
/// <para>
/// Only a self-signed certificate can be imported as a root CA.
/// </para>
/// </li> <li>
/// <para>
/// A self-signed certificate cannot be imported as a subordinate CA.
/// </para>
/// </li> <li>
/// <para>
/// Your certificate chain must not include the private CA certificate that you are importing.
/// </para>
/// </li> <li>
/// <para>
/// Your root CA must be the last certificate in your chain. The subordinate certificate,
/// if any, that your root CA signed must be next to last. The subordinate certificate
/// signed by the preceding subordinate CA must come next, and so on until your chain
/// is built.
/// </para>
/// </li> <li>
/// <para>
/// The chain must be PEM-encoded.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate is 32 KB.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate chain is 2 MB.
/// </para>
/// </li> </ul>
/// <para>
/// <i>Enforcement of Critical Constraints</i>
/// </para>
///
/// <para>
/// Amazon Web Services Private CA allows the following extensions to be marked critical
/// in the imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Basic constraints (<i>must</i> be marked critical)
/// </para>
/// </li> <li>
/// <para>
/// Subject alternative names
/// </para>
/// </li> <li>
/// <para>
/// Key usage
/// </para>
/// </li> <li>
/// <para>
/// Extended key usage
/// </para>
/// </li> <li>
/// <para>
/// Authority key identifier
/// </para>
/// </li> <li>
/// <para>
/// Subject key identifier
/// </para>
/// </li> <li>
/// <para>
/// Issuer alternative name
/// </para>
/// </li> <li>
/// <para>
/// Subject directory attributes
/// </para>
/// </li> <li>
/// <para>
/// Subject information access
/// </para>
/// </li> <li>
/// <para>
/// Certificate policies
/// </para>
/// </li> <li>
/// <para>
/// Policy mappings
/// </para>
/// </li> <li>
/// <para>
/// Inhibit anyPolicy
/// </para>
/// </li> </ul>
/// <para>
/// Amazon Web Services Private CA rejects the following extensions when they are marked
/// critical in an imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Name constraints
/// </para>
/// </li> <li>
/// <para>
/// Policy constraints
/// </para>
/// </li> <li>
/// <para>
/// CRL distribution points
/// </para>
/// </li> <li>
/// <para>
/// Authority information access
/// </para>
/// </li> <li>
/// <para>
/// Freshest CRL
/// </para>
/// </li> <li>
/// <para>
/// Any other extension
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate service method.</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 ImportCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.CertificateMismatchException">
/// The certificate authority certificate you are importing does not comply with conditions
/// specified in the certificate that signed it.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCertificateException">
/// One or more fields in the certificate are invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
Task<ImportCertificateAuthorityCertificateResponse> ImportCertificateAuthorityCertificateAsync(ImportCertificateAuthorityCertificateRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region IssueCertificate
/// <summary>
/// Uses your private certificate authority (CA), or one that has been shared with you,
/// to issue a client certificate. This action returns the Amazon Resource Name (ARN)
/// of the certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a>
/// action and specifying the ARN.
///
/// <note>
/// <para>
/// You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs
/// of the certificates that you issue by using Amazon Web Services Private CA.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate service method.</param>
///
/// <returns>The response from the IssueCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCSRException">
/// The certificate signing request is invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
IssueCertificateResponse IssueCertificate(IssueCertificateRequest request);
/// <summary>
/// Uses your private certificate authority (CA), or one that has been shared with you,
/// to issue a client certificate. This action returns the Amazon Resource Name (ARN)
/// of the certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a>
/// action and specifying the ARN.
///
/// <note>
/// <para>
/// You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs
/// of the certificates that you issue by using Amazon Web Services Private CA.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate service method.</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 IssueCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCSRException">
/// The certificate signing request is invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
Task<IssueCertificateResponse> IssueCertificateAsync(IssueCertificateRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListCertificateAuthorities
/// <summary>
/// Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities service method.</param>
///
/// <returns>The response from the ListCertificateAuthorities service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
ListCertificateAuthoritiesResponse ListCertificateAuthorities(ListCertificateAuthoritiesRequest request);
/// <summary>
/// Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities service method.</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 ListCertificateAuthorities service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
Task<ListCertificateAuthoritiesResponse> ListCertificateAuthoritiesAsync(ListCertificateAuthoritiesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListPermissions
/// <summary>
/// List all permissions on a private CA, if any, granted to the Certificate Manager (ACM)
/// service principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListPermissions service method.</param>
///
/// <returns>The response from the ListPermissions service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
ListPermissionsResponse ListPermissions(ListPermissionsRequest request);
/// <summary>
/// List all permissions on a private CA, if any, granted to the Certificate Manager (ACM)
/// service principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListPermissions service method.</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 ListPermissions service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
Task<ListPermissionsResponse> ListPermissionsAsync(ListPermissionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTags
/// <summary>
/// Lists the tags, if any, that are associated with your private CA or one that has been
/// shared with you. Tags are labels that you can use to identify and organize your CAs.
/// Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
/// action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action to remove tags.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListTags service method.</param>
///
/// <returns>The response from the ListTags service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
ListTagsResponse ListTags(ListTagsRequest request);
/// <summary>
/// Lists the tags, if any, that are associated with your private CA or one that has been
/// shared with you. Tags are labels that you can use to identify and organize your CAs.
/// Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
/// action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action to remove tags.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListTags service method.</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 ListTags service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
Task<ListTagsResponse> ListTagsAsync(ListTagsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutPolicy
/// <summary>
/// Attaches a resource-based policy to a private CA.
///
///
/// <para>
/// A policy can also be applied by sharing a private CA through Amazon Web Services Resource
/// Access Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
///
/// <para>
/// The policy can be displayed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the PutPolicy service method.</param>
///
/// <returns>The response from the PutPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
PutPolicyResponse PutPolicy(PutPolicyRequest request);
/// <summary>
/// Attaches a resource-based policy to a private CA.
///
///
/// <para>
/// A policy can also be applied by sharing a private CA through Amazon Web Services Resource
/// Access Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
///
/// <para>
/// The policy can be displayed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the PutPolicy service method.</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 PutPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
Task<PutPolicyResponse> PutPolicyAsync(PutPolicyRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RestoreCertificateAuthority
/// <summary>
/// Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
/// can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b>
/// parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>
/// action. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b>
/// value, by default you can restore the CA at any time in a 30 day period. You can check
/// the time remaining in the restoration period of a private CA in the <code>DELETED</code>
/// state by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// or <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// actions. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b>
/// action returns. To change its status to <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion,
/// you must use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action to import a certificate authority into the private CA before it can be activated.
/// You cannot restore a CA after the restoration period has ended.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority service method.</param>
///
/// <returns>The response from the RestoreCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
RestoreCertificateAuthorityResponse RestoreCertificateAuthority(RestoreCertificateAuthorityRequest request);
/// <summary>
/// Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
/// can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b>
/// parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>
/// action. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b>
/// value, by default you can restore the CA at any time in a 30 day period. You can check
/// the time remaining in the restoration period of a private CA in the <code>DELETED</code>
/// state by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// or <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// actions. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b>
/// action returns. To change its status to <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion,
/// you must use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action to import a certificate authority into the private CA before it can be activated.
/// You cannot restore a CA after the restoration period has ended.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority service method.</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 RestoreCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
Task<RestoreCertificateAuthorityResponse> RestoreCertificateAuthorityAsync(RestoreCertificateAuthorityRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RevokeCertificate
/// <summary>
/// Revokes a certificate that was issued inside Amazon Web Services Private CA. If you
/// enable a certificate revocation list (CRL) when you create or update your private
/// CA, information about the revoked certificates will be included in the CRL. Amazon
/// Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is
/// typically updated approximately 30 minutes after a certificate is revoked. If for
/// any reason the CRL update fails, Amazon Web Services Private CA attempts makes further
/// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
/// <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information,
/// see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported
/// CloudWatch Metrics</a>.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA also writes revocation information to the audit report.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.
/// </para>
/// <note>
/// <para>
/// You cannot revoke a root CA self-signed certificate.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate service method.</param>
///
/// <returns>The response from the RevokeCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestAlreadyProcessedException">
/// Your request has already been completed.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
RevokeCertificateResponse RevokeCertificate(RevokeCertificateRequest request);
/// <summary>
/// Revokes a certificate that was issued inside Amazon Web Services Private CA. If you
/// enable a certificate revocation list (CRL) when you create or update your private
/// CA, information about the revoked certificates will be included in the CRL. Amazon
/// Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is
/// typically updated approximately 30 minutes after a certificate is revoked. If for
/// any reason the CRL update fails, Amazon Web Services Private CA attempts makes further
/// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
/// <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information,
/// see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported
/// CloudWatch Metrics</a>.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA also writes revocation information to the audit report.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.
/// </para>
/// <note>
/// <para>
/// You cannot revoke a root CA self-signed certificate.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate service method.</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 RevokeCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestAlreadyProcessedException">
/// Your request has already been completed.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
Task<RevokeCertificateResponse> RevokeCertificateAsync(RevokeCertificateRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagCertificateAuthority
/// <summary>
/// Adds one or more tags to your private CA. Tags are labels that you can use to identify
/// and organize your Amazon Web Services resources. Each tag consists of a key and an
/// optional value. You specify the private CA on input by its Amazon Resource Name (ARN).
/// You specify the tag by using a key-value pair. You can apply a tag to just one private
/// CA if you want to identify a specific characteristic of that CA, or you can apply
/// the same tag to multiple private CAs if you want to filter for a common relationship
/// among those CAs. To remove one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
///
/// <note>
/// <para>
/// To attach tags to a private CA during the creation procedure, a CA administrator must
/// first associate an inline IAM policy with the <code>CreateCertificateAuthority</code>
/// action and explicitly allow tagging. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching
/// tags to a CA at the time of creation</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority service method.</param>
///
/// <returns>The response from the TagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.TooManyTagsException">
/// You can associate up to 50 tags with a private CA. Exception information is contained
/// in the exception message field.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
TagCertificateAuthorityResponse TagCertificateAuthority(TagCertificateAuthorityRequest request);
/// <summary>
/// Adds one or more tags to your private CA. Tags are labels that you can use to identify
/// and organize your Amazon Web Services resources. Each tag consists of a key and an
/// optional value. You specify the private CA on input by its Amazon Resource Name (ARN).
/// You specify the tag by using a key-value pair. You can apply a tag to just one private
/// CA if you want to identify a specific characteristic of that CA, or you can apply
/// the same tag to multiple private CAs if you want to filter for a common relationship
/// among those CAs. To remove one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
///
/// <note>
/// <para>
/// To attach tags to a private CA during the creation procedure, a CA administrator must
/// first associate an inline IAM policy with the <code>CreateCertificateAuthority</code>
/// action and explicitly allow tagging. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching
/// tags to a CA at the time of creation</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority service method.</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 TagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.TooManyTagsException">
/// You can associate up to 50 tags with a private CA. Exception information is contained
/// in the exception message field.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
Task<TagCertificateAuthorityResponse> TagCertificateAuthorityAsync(TagCertificateAuthorityRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagCertificateAuthority
/// <summary>
/// Remove one or more tags from your private CA. A tag consists of a key-value pair.
/// If you do not specify the value portion of the tag when calling this action, the tag
/// will be removed regardless of value. If you specify a value, the tag is removed only
/// if it is associated with the specified value. To add tags to a private CA, use the
/// <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>.
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority service method.</param>
///
/// <returns>The response from the UntagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
UntagCertificateAuthorityResponse UntagCertificateAuthority(UntagCertificateAuthorityRequest request);
/// <summary>
/// Remove one or more tags from your private CA. A tag consists of a key-value pair.
/// If you do not specify the value portion of the tag when calling this action, the tag
/// will be removed regardless of value. If you specify a value, the tag is removed only
/// if it is associated with the specified value. To add tags to a private CA, use the
/// <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>.
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority service method.</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 UntagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
Task<UntagCertificateAuthorityResponse> UntagCertificateAuthorityAsync(UntagCertificateAuthorityRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateCertificateAuthority
/// <summary>
/// Updates the status or configuration of a private certificate authority (CA). Your
/// private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before
/// you can update it. You can disable a private CA that is in the <code>ACTIVE</code>
/// state or make a CA that is in the <code>DISABLED</code> state active again.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority service method.</param>
///
/// <returns>The response from the UpdateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
UpdateCertificateAuthorityResponse UpdateCertificateAuthority(UpdateCertificateAuthorityRequest request);
/// <summary>
/// Updates the status or configuration of a private certificate authority (CA). Your
/// private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before
/// you can update it. You can disable a private CA that is in the <code>ACTIVE</code>
/// state or make a CA that is in the <code>DISABLED</code> state active again.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority service method.</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 UpdateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
Task<UpdateCertificateAuthorityResponse> UpdateCertificateAuthorityAsync(UpdateCertificateAuthorityRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
} | 2,710 |
aws-sdk-net | aws | C# | /*
* 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 acm-pca-2017-08-22.normal.json service model.
*/
using System;
using System.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Net;
using Amazon.ACMPCA.Model;
using Amazon.ACMPCA.Model.Internal.MarshallTransformations;
using Amazon.ACMPCA.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.ACMPCA
{
/// <summary>
/// Implementation for accessing ACMPCA
///
/// This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>.
/// It provides descriptions, syntax, and usage examples for each of the actions and data
/// types involved in creating and managing a private certificate authority (CA) for your
/// organization.
///
///
/// <para>
/// The documentation for each action shows the API request parameters and the JSON response.
/// Alternatively, you can use one of the Amazon Web Services SDKs to access an API that
/// is tailored to the programming language or platform that you prefer. For more information,
/// see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.
/// </para>
///
/// <para>
/// Each Amazon Web Services Private CA API operation has a quota that determines the
/// number of times the operation can be called per second. Amazon Web Services Private
/// CA throttles API requests at different rates depending on the operation. Throttling
/// means that Amazon Web Services Private CA rejects an otherwise valid request because
/// the request exceeds the operation's quota for the number of requests per second. When
/// a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a>
/// error. Amazon Web Services Private CA does not guarantee a minimum request rate for
/// APIs.
/// </para>
///
/// <para>
/// To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request
/// a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service
/// Quotas</a> console.
/// </para>
/// </summary>
public partial class AmazonACMPCAClient : AmazonServiceClient, IAmazonACMPCA
{
private static IServiceMetadata serviceMetadata = new AmazonACMPCAMetadata();
#region Constructors
/// <summary>
/// Constructs AmazonACMPCAClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
public AmazonACMPCAClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonACMPCAConfig()) { }
/// <summary>
/// Constructs AmazonACMPCAClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonACMPCAConfig{RegionEndpoint = region}) { }
/// <summary>
/// Constructs AmazonACMPCAClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
/// <param name="config">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(AmazonACMPCAConfig config)
: base(FallbackCredentialsFactory.GetCredentials(), config) { }
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Credentials
/// </summary>
/// <param name="credentials">AWS Credentials</param>
public AmazonACMPCAClient(AWSCredentials credentials)
: this(credentials, new AmazonACMPCAConfig())
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Credentials
/// </summary>
/// <param name="credentials">AWS Credentials</param>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonACMPCAConfig{RegionEndpoint = region})
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Credentials and an
/// AmazonACMPCAClient Configuration object.
/// </summary>
/// <param name="credentials">AWS Credentials</param>
/// <param name="clientConfig">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(AWSCredentials credentials, AmazonACMPCAConfig clientConfig)
: base(credentials, clientConfig)
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonACMPCAConfig())
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonACMPCAConfig() {RegionEndpoint=region})
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonACMPCAClient Configuration object.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="clientConfig">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonACMPCAConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonACMPCAConfig())
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID and AWS Secret Key
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
/// <param name="region">The region to connect.</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonACMPCAConfig{RegionEndpoint = region})
{
}
/// <summary>
/// Constructs AmazonACMPCAClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonACMPCAClient Configuration object.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
/// <param name="clientConfig">The AmazonACMPCAClient Configuration Object</param>
public AmazonACMPCAClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonACMPCAConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#if AWS_ASYNC_ENUMERABLES_API
private IACMPCAPaginatorFactory _paginators;
/// <summary>
/// Paginators for the service
/// </summary>
public IACMPCAPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new ACMPCAPaginatorFactory(this);
}
return this._paginators;
}
}
#endif
#region Overrides
/// <summary>
/// Creates the signer for the service.
/// </summary>
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
/// <summary>
/// Customizes the runtime pipeline.
/// </summary>
/// <param name="pipeline">Runtime pipeline for the current client.</param>
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler<Amazon.Runtime.Internal.EndpointResolver>();
pipeline.AddHandlerAfter<Amazon.Runtime.Internal.Marshaller>(new AmazonACMPCAEndpointResolver());
}
/// <summary>
/// Capture metadata for the service.
/// </summary>
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
/// <summary>
/// Disposes the service client.
/// </summary>
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region CreateCertificateAuthority
internal virtual CreateCertificateAuthorityResponse CreateCertificateAuthority(CreateCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<CreateCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Creates a root or subordinate private certificate authority (CA). You must specify
/// the CA configuration, an optional configuration for Online Certificate Status Protocol
/// (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency
/// token to avoid accidental creation of multiple CAs. The CA configuration specifies
/// the name of the algorithm and key size to be used to create the CA private key, the
/// type of signing algorithm that the CA uses, and X.500 subject information. The OCSP
/// configuration can optionally specify a custom URL for the OCSP responder. The CRL
/// configuration specifies the CRL expiration period in days (the validity period of
/// the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the
/// S3 bucket that is included in certificates issued by the CA. If successful, this action
/// returns the Amazon Resource Name (ARN) of the CA.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting
/// Your CRLs</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority service method.</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 CreateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
public virtual Task<CreateCertificateAuthorityResponse> CreateCertificateAuthorityAsync(CreateCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<CreateCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region CreateCertificateAuthorityAuditReport
internal virtual CreateCertificateAuthorityAuditReportResponse CreateCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return Invoke<CreateCertificateAuthorityAuditReportResponse>(request, options);
}
/// <summary>
/// Creates an audit report that lists every time that your CA private key is used. The
/// report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// actions use the private key.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting
/// Your Audit Reports</a>.
/// </para>
/// <note>
/// <para>
/// You can generate a maximum of one report every 30 minutes.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport service method.</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 CreateCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
public virtual Task<CreateCertificateAuthorityAuditReportResponse> CreateCertificateAuthorityAuditReportAsync(CreateCertificateAuthorityAuditReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return InvokeAsync<CreateCertificateAuthorityAuditReportResponse>(request, options, cancellationToken);
}
#endregion
#region CreatePermission
internal virtual CreatePermissionResponse CreatePermission(CreatePermissionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreatePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreatePermissionResponseUnmarshaller.Instance;
return Invoke<CreatePermissionResponse>(request, options);
}
/// <summary>
/// Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
/// principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
/// renew ACM certificates that reside in the same Amazon Web Services account as the
/// CA.
///
///
/// <para>
/// You can list current permissions with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action and revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreatePermission service method.</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 CreatePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.PermissionAlreadyExistsException">
/// The designated permission has already been given to the user.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
public virtual Task<CreatePermissionResponse> CreatePermissionAsync(CreatePermissionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreatePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreatePermissionResponseUnmarshaller.Instance;
return InvokeAsync<CreatePermissionResponse>(request, options, cancellationToken);
}
#endregion
#region DeleteCertificateAuthority
internal virtual DeleteCertificateAuthorityResponse DeleteCertificateAuthority(DeleteCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<DeleteCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Deletes a private certificate authority (CA). You must provide the Amazon Resource
/// Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
/// the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// action.
///
/// <note>
/// <para>
/// Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
/// </para>
/// </note>
/// <para>
/// Before you can delete a CA that you have created and activated, you must disable it.
/// To do this, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>.
///
/// </para>
///
/// <para>
/// Additionally, you can delete a CA if you are waiting for it to be created (that is,
/// the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
/// been created but you haven't yet imported the signed certificate into Amazon Web Services
/// Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>).
/// </para>
///
/// <para>
/// When you successfully call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>,
/// the CA's status changes to <code>DELETED</code>. However, the CA won't be permanently
/// deleted until the restoration period has passed. By default, if you do not set the
/// <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for
/// 30 days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// action returns the time remaining in the restoration window of a private CA in the
/// <code>DELETED</code> state. To restore an eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a>
/// action.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority service method.</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 DeleteCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
public virtual Task<DeleteCertificateAuthorityResponse> DeleteCertificateAuthorityAsync(DeleteCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<DeleteCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region DeletePermission
internal virtual DeletePermissionResponse DeletePermission(DeletePermissionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePermissionResponseUnmarshaller.Instance;
return Invoke<DeletePermissionResponse>(request, options);
}
/// <summary>
/// Revokes permissions on a private CA granted to the Certificate Manager (ACM) service
/// principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA. If you revoke these permissions, ACM will
/// no longer renew the affected certificates automatically.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePermission service method.</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 DeletePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
public virtual Task<DeletePermissionResponse> DeletePermissionAsync(DeletePermissionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePermissionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePermissionResponseUnmarshaller.Instance;
return InvokeAsync<DeletePermissionResponse>(request, options, cancellationToken);
}
#endregion
#region DeletePolicy
internal virtual DeletePolicyResponse DeletePolicy(DeletePolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePolicyResponseUnmarshaller.Instance;
return Invoke<DeletePolicyResponse>(request, options);
}
/// <summary>
/// Deletes the resource-based policy attached to a private CA. Deletion will remove any
/// access that the policy has granted. If there is no policy attached to the private
/// CA, this action will return successful.
///
///
/// <para>
/// If you delete a policy that was applied through Amazon Web Services Resource Access
/// Manager (RAM), the CA will be removed from all shares in which it was included.
/// </para>
///
/// <para>
/// The Certificate Manager Service Linked Role that the policy supports is not affected
/// when you delete the policy.
/// </para>
///
/// <para>
/// The current policy can be shown with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</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 DeletePolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
public virtual Task<DeletePolicyResponse> DeletePolicyAsync(DeletePolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePolicyResponseUnmarshaller.Instance;
return InvokeAsync<DeletePolicyResponse>(request, options, cancellationToken);
}
#endregion
#region DescribeCertificateAuthority
internal virtual DescribeCertificateAuthorityResponse DescribeCertificateAuthority(DescribeCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<DescribeCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Lists information about your private certificate authority (CA) or one that has been
/// shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
/// The output contains the status of your CA. This can be any of the following:
///
/// <ul> <li>
/// <para>
/// <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
/// authority.
/// </para>
/// </li> <li>
/// <para>
/// <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your
/// Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign
/// your private CA CSR and then import it into Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>ACTIVE</code> - Your private CA is active.
/// </para>
/// </li> <li>
/// <para>
/// <code>DISABLED</code> - Your private CA has been disabled.
/// </para>
/// </li> <li>
/// <para>
/// <code>EXPIRED</code> - Your private CA certificate has expired.
/// </para>
/// </li> <li>
/// <para>
/// <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems
/// such a network outage or back-end Amazon Web Services failure or other errors. A failed
/// CA can never return to the pending state. You must create a new CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>DELETED</code> - Your private CA is within the restoration period, after which
/// it is permanently deleted. The length of time remaining in the CA's restoration period
/// is also included in this action's output.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority service method.</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 DescribeCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
public virtual Task<DescribeCertificateAuthorityResponse> DescribeCertificateAuthorityAsync(DescribeCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<DescribeCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region DescribeCertificateAuthorityAuditReport
internal virtual DescribeCertificateAuthorityAuditReportResponse DescribeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return Invoke<DescribeCertificateAuthorityAuditReportResponse>(request, options);
}
/// <summary>
/// Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action. Audit information is created every time the certificate authority (CA) private
/// key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport service method.</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 DescribeCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
public virtual Task<DescribeCertificateAuthorityAuditReportResponse> DescribeCertificateAuthorityAuditReportAsync(DescribeCertificateAuthorityAuditReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificateAuthorityAuditReportRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificateAuthorityAuditReportResponseUnmarshaller.Instance;
return InvokeAsync<DescribeCertificateAuthorityAuditReportResponse>(request, options, cancellationToken);
}
#endregion
#region GetCertificate
internal virtual GetCertificateResponse GetCertificate(GetCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateResponseUnmarshaller.Instance;
return Invoke<GetCertificateResponse>(request, options);
}
/// <summary>
/// Retrieves a certificate from your private CA or one that has been shared with you.
/// The ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action. You must specify both the ARN of your private CA and the ARN of the issued
/// certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate
/// if it is in the <b>ISSUED</b> state. You can call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action to create a report that contains information about all of the certificates
/// issued and revoked by your private CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificate service method.</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 GetCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
public virtual Task<GetCertificateResponse> GetCertificateAsync(GetCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateResponseUnmarshaller.Instance;
return InvokeAsync<GetCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region GetCertificateAuthorityCertificate
internal virtual GetCertificateAuthorityCertificateResponse GetCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return Invoke<GetCertificateAuthorityCertificateResponse>(request, options);
}
/// <summary>
/// Retrieves the certificate and certificate chain for your private certificate authority
/// (CA) or one that has been shared with you. Both the certificate and the chain are
/// base64 PEM-encoded. The chain does not include the CA certificate. Each certificate
/// in the chain signs the one before it.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate service method.</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 GetCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
public virtual Task<GetCertificateAuthorityCertificateResponse> GetCertificateAuthorityCertificateAsync(GetCertificateAuthorityCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return InvokeAsync<GetCertificateAuthorityCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region GetCertificateAuthorityCsr
internal virtual GetCertificateAuthorityCsrResponse GetCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCsrRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCsrResponseUnmarshaller.Instance;
return Invoke<GetCertificateAuthorityCsrResponse>(request, options);
}
/// <summary>
/// Retrieves the certificate signing request (CSR) for your private certificate authority
/// (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises
/// root or subordinate CA. Then import the signed certificate back into Amazon Web Services
/// Private CA by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action. The CSR is returned as a base64 PEM-encoded string.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr service method.</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 GetCertificateAuthorityCsr service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
public virtual Task<GetCertificateAuthorityCsrResponse> GetCertificateAuthorityCsrAsync(GetCertificateAuthorityCsrRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCertificateAuthorityCsrRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCertificateAuthorityCsrResponseUnmarshaller.Instance;
return InvokeAsync<GetCertificateAuthorityCsrResponse>(request, options, cancellationToken);
}
#endregion
#region GetPolicy
internal virtual GetPolicyResponse GetPolicy(GetPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPolicyResponseUnmarshaller.Instance;
return Invoke<GetPolicyResponse>(request, options);
}
/// <summary>
/// Retrieves the resource-based policy attached to a private CA. If either the private
/// CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>.
///
///
///
/// <para>
/// The policy can be attached or updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</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 GetPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
public virtual Task<GetPolicyResponse> GetPolicyAsync(GetPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPolicyResponseUnmarshaller.Instance;
return InvokeAsync<GetPolicyResponse>(request, options, cancellationToken);
}
#endregion
#region ImportCertificateAuthorityCertificate
internal virtual ImportCertificateAuthorityCertificateResponse ImportCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ImportCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = ImportCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return Invoke<ImportCertificateAuthorityCertificateResponse>(request, options);
}
/// <summary>
/// Imports a signed private CA certificate into Amazon Web Services Private CA. This
/// action is used when you are using a chain of trust whose root is located outside Amazon
/// Web Services Private CA. Before you can call this action, the following preparations
/// must in place:
///
/// <ol> <li>
/// <para>
/// In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action to create the private CA that you plan to back with the imported certificate.
/// </para>
/// </li> <li>
/// <para>
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a>
/// action to generate a certificate signing request (CSR).
/// </para>
/// </li> <li>
/// <para>
/// Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy
/// or by a commercial CA.
/// </para>
/// </li> <li>
/// <para>
/// Create a certificate chain and copy the signed certificate and the certificate chain
/// to your working directory.
/// </para>
/// </li> </ol>
/// <para>
/// Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
/// </para>
/// <ul> <li>
/// <para>
/// Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is hosted by Amazon
/// Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is externally hosted.
/// </para>
/// </li> </ul>
/// <para>
/// The following additional requirements apply when you import a CA certificate.
/// </para>
/// <ul> <li>
/// <para>
/// Only a self-signed certificate can be imported as a root CA.
/// </para>
/// </li> <li>
/// <para>
/// A self-signed certificate cannot be imported as a subordinate CA.
/// </para>
/// </li> <li>
/// <para>
/// Your certificate chain must not include the private CA certificate that you are importing.
/// </para>
/// </li> <li>
/// <para>
/// Your root CA must be the last certificate in your chain. The subordinate certificate,
/// if any, that your root CA signed must be next to last. The subordinate certificate
/// signed by the preceding subordinate CA must come next, and so on until your chain
/// is built.
/// </para>
/// </li> <li>
/// <para>
/// The chain must be PEM-encoded.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate is 32 KB.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate chain is 2 MB.
/// </para>
/// </li> </ul>
/// <para>
/// <i>Enforcement of Critical Constraints</i>
/// </para>
///
/// <para>
/// Amazon Web Services Private CA allows the following extensions to be marked critical
/// in the imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Basic constraints (<i>must</i> be marked critical)
/// </para>
/// </li> <li>
/// <para>
/// Subject alternative names
/// </para>
/// </li> <li>
/// <para>
/// Key usage
/// </para>
/// </li> <li>
/// <para>
/// Extended key usage
/// </para>
/// </li> <li>
/// <para>
/// Authority key identifier
/// </para>
/// </li> <li>
/// <para>
/// Subject key identifier
/// </para>
/// </li> <li>
/// <para>
/// Issuer alternative name
/// </para>
/// </li> <li>
/// <para>
/// Subject directory attributes
/// </para>
/// </li> <li>
/// <para>
/// Subject information access
/// </para>
/// </li> <li>
/// <para>
/// Certificate policies
/// </para>
/// </li> <li>
/// <para>
/// Policy mappings
/// </para>
/// </li> <li>
/// <para>
/// Inhibit anyPolicy
/// </para>
/// </li> </ul>
/// <para>
/// Amazon Web Services Private CA rejects the following extensions when they are marked
/// critical in an imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Name constraints
/// </para>
/// </li> <li>
/// <para>
/// Policy constraints
/// </para>
/// </li> <li>
/// <para>
/// CRL distribution points
/// </para>
/// </li> <li>
/// <para>
/// Authority information access
/// </para>
/// </li> <li>
/// <para>
/// Freshest CRL
/// </para>
/// </li> <li>
/// <para>
/// Any other extension
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate service method.</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 ImportCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.CertificateMismatchException">
/// The certificate authority certificate you are importing does not comply with conditions
/// specified in the certificate that signed it.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCertificateException">
/// One or more fields in the certificate are invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
public virtual Task<ImportCertificateAuthorityCertificateResponse> ImportCertificateAuthorityCertificateAsync(ImportCertificateAuthorityCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ImportCertificateAuthorityCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = ImportCertificateAuthorityCertificateResponseUnmarshaller.Instance;
return InvokeAsync<ImportCertificateAuthorityCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region IssueCertificate
internal virtual IssueCertificateResponse IssueCertificate(IssueCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = IssueCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = IssueCertificateResponseUnmarshaller.Instance;
return Invoke<IssueCertificateResponse>(request, options);
}
/// <summary>
/// Uses your private certificate authority (CA), or one that has been shared with you,
/// to issue a client certificate. This action returns the Amazon Resource Name (ARN)
/// of the certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a>
/// action and specifying the ARN.
///
/// <note>
/// <para>
/// You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs
/// of the certificates that you issue by using Amazon Web Services Private CA.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate service method.</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 IssueCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCSRException">
/// The certificate signing request is invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
public virtual Task<IssueCertificateResponse> IssueCertificateAsync(IssueCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = IssueCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = IssueCertificateResponseUnmarshaller.Instance;
return InvokeAsync<IssueCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region ListCertificateAuthorities
internal virtual ListCertificateAuthoritiesResponse ListCertificateAuthorities(ListCertificateAuthoritiesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCertificateAuthoritiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCertificateAuthoritiesResponseUnmarshaller.Instance;
return Invoke<ListCertificateAuthoritiesResponse>(request, options);
}
/// <summary>
/// Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities service method.</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 ListCertificateAuthorities service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
public virtual Task<ListCertificateAuthoritiesResponse> ListCertificateAuthoritiesAsync(ListCertificateAuthoritiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListCertificateAuthoritiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListCertificateAuthoritiesResponseUnmarshaller.Instance;
return InvokeAsync<ListCertificateAuthoritiesResponse>(request, options, cancellationToken);
}
#endregion
#region ListPermissions
internal virtual ListPermissionsResponse ListPermissions(ListPermissionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPermissionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPermissionsResponseUnmarshaller.Instance;
return Invoke<ListPermissionsResponse>(request, options);
}
/// <summary>
/// List all permissions on a private CA, if any, granted to the Certificate Manager (ACM)
/// service principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListPermissions service method.</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 ListPermissions service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
public virtual Task<ListPermissionsResponse> ListPermissionsAsync(ListPermissionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPermissionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPermissionsResponseUnmarshaller.Instance;
return InvokeAsync<ListPermissionsResponse>(request, options, cancellationToken);
}
#endregion
#region ListTags
internal virtual ListTagsResponse ListTags(ListTagsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsResponseUnmarshaller.Instance;
return Invoke<ListTagsResponse>(request, options);
}
/// <summary>
/// Lists the tags, if any, that are associated with your private CA or one that has been
/// shared with you. Tags are labels that you can use to identify and organize your CAs.
/// Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
/// action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action to remove tags.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListTags service method.</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 ListTags service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
public virtual Task<ListTagsResponse> ListTagsAsync(ListTagsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsResponseUnmarshaller.Instance;
return InvokeAsync<ListTagsResponse>(request, options, cancellationToken);
}
#endregion
#region PutPolicy
internal virtual PutPolicyResponse PutPolicy(PutPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutPolicyResponseUnmarshaller.Instance;
return Invoke<PutPolicyResponse>(request, options);
}
/// <summary>
/// Attaches a resource-based policy to a private CA.
///
///
/// <para>
/// A policy can also be applied by sharing a private CA through Amazon Web Services Resource
/// Access Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
///
/// <para>
/// The policy can be displayed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the PutPolicy service method.</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 PutPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
public virtual Task<PutPolicyResponse> PutPolicyAsync(PutPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutPolicyResponseUnmarshaller.Instance;
return InvokeAsync<PutPolicyResponse>(request, options, cancellationToken);
}
#endregion
#region RestoreCertificateAuthority
internal virtual RestoreCertificateAuthorityResponse RestoreCertificateAuthority(RestoreCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<RestoreCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
/// can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b>
/// parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>
/// action. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b>
/// value, by default you can restore the CA at any time in a 30 day period. You can check
/// the time remaining in the restoration period of a private CA in the <code>DELETED</code>
/// state by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// or <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// actions. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b>
/// action returns. To change its status to <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion,
/// you must use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action to import a certificate authority into the private CA before it can be activated.
/// You cannot restore a CA after the restoration period has ended.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority service method.</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 RestoreCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
public virtual Task<RestoreCertificateAuthorityResponse> RestoreCertificateAuthorityAsync(RestoreCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<RestoreCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region RevokeCertificate
internal virtual RevokeCertificateResponse RevokeCertificate(RevokeCertificateRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RevokeCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = RevokeCertificateResponseUnmarshaller.Instance;
return Invoke<RevokeCertificateResponse>(request, options);
}
/// <summary>
/// Revokes a certificate that was issued inside Amazon Web Services Private CA. If you
/// enable a certificate revocation list (CRL) when you create or update your private
/// CA, information about the revoked certificates will be included in the CRL. Amazon
/// Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is
/// typically updated approximately 30 minutes after a certificate is revoked. If for
/// any reason the CRL update fails, Amazon Web Services Private CA attempts makes further
/// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
/// <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information,
/// see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported
/// CloudWatch Metrics</a>.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA also writes revocation information to the audit report.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.
/// </para>
/// <note>
/// <para>
/// You cannot revoke a root CA self-signed certificate.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate service method.</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 RevokeCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestAlreadyProcessedException">
/// Your request has already been completed.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
public virtual Task<RevokeCertificateResponse> RevokeCertificateAsync(RevokeCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RevokeCertificateRequestMarshaller.Instance;
options.ResponseUnmarshaller = RevokeCertificateResponseUnmarshaller.Instance;
return InvokeAsync<RevokeCertificateResponse>(request, options, cancellationToken);
}
#endregion
#region TagCertificateAuthority
internal virtual TagCertificateAuthorityResponse TagCertificateAuthority(TagCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<TagCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Adds one or more tags to your private CA. Tags are labels that you can use to identify
/// and organize your Amazon Web Services resources. Each tag consists of a key and an
/// optional value. You specify the private CA on input by its Amazon Resource Name (ARN).
/// You specify the tag by using a key-value pair. You can apply a tag to just one private
/// CA if you want to identify a specific characteristic of that CA, or you can apply
/// the same tag to multiple private CAs if you want to filter for a common relationship
/// among those CAs. To remove one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
///
/// <note>
/// <para>
/// To attach tags to a private CA during the creation procedure, a CA administrator must
/// first associate an inline IAM policy with the <code>CreateCertificateAuthority</code>
/// action and explicitly allow tagging. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching
/// tags to a CA at the time of creation</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority service method.</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 TagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.TooManyTagsException">
/// You can associate up to 50 tags with a private CA. Exception information is contained
/// in the exception message field.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
public virtual Task<TagCertificateAuthorityResponse> TagCertificateAuthorityAsync(TagCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = TagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<TagCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region UntagCertificateAuthority
internal virtual UntagCertificateAuthorityResponse UntagCertificateAuthority(UntagCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<UntagCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Remove one or more tags from your private CA. A tag consists of a key-value pair.
/// If you do not specify the value portion of the tag when calling this action, the tag
/// will be removed regardless of value. If you specify a value, the tag is removed only
/// if it is associated with the specified value. To add tags to a private CA, use the
/// <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>.
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority service method.</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 UntagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
public virtual Task<UntagCertificateAuthorityResponse> UntagCertificateAuthorityAsync(UntagCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<UntagCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
#region UpdateCertificateAuthority
internal virtual UpdateCertificateAuthorityResponse UpdateCertificateAuthority(UpdateCertificateAuthorityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCertificateAuthorityResponseUnmarshaller.Instance;
return Invoke<UpdateCertificateAuthorityResponse>(request, options);
}
/// <summary>
/// Updates the status or configuration of a private certificate authority (CA). Your
/// private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before
/// you can update it. You can disable a private CA that is in the <code>ACTIVE</code>
/// state or make a CA that is in the <code>DISABLED</code> state active again.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority service method.</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 UpdateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
public virtual Task<UpdateCertificateAuthorityResponse> UpdateCertificateAuthorityAsync(UpdateCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCertificateAuthorityRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCertificateAuthorityResponseUnmarshaller.Instance;
return InvokeAsync<UpdateCertificateAuthorityResponse>(request, options, cancellationToken);
}
#endregion
}
} | 2,077 |
aws-sdk-net | aws | C# | /*
* 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 acm-pca-2017-08-22.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.ACMPCA.Model;
namespace Amazon.ACMPCA
{
/// <summary>
/// Interface for accessing ACMPCA
///
/// This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>.
/// It provides descriptions, syntax, and usage examples for each of the actions and data
/// types involved in creating and managing a private certificate authority (CA) for your
/// organization.
///
///
/// <para>
/// The documentation for each action shows the API request parameters and the JSON response.
/// Alternatively, you can use one of the Amazon Web Services SDKs to access an API that
/// is tailored to the programming language or platform that you prefer. For more information,
/// see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.
/// </para>
///
/// <para>
/// Each Amazon Web Services Private CA API operation has a quota that determines the
/// number of times the operation can be called per second. Amazon Web Services Private
/// CA throttles API requests at different rates depending on the operation. Throttling
/// means that Amazon Web Services Private CA rejects an otherwise valid request because
/// the request exceeds the operation's quota for the number of requests per second. When
/// a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a>
/// error. Amazon Web Services Private CA does not guarantee a minimum request rate for
/// APIs.
/// </para>
///
/// <para>
/// To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request
/// a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service
/// Quotas</a> console.
/// </para>
/// </summary>
public partial interface IAmazonACMPCA : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
/// <summary>
/// Paginators for the service
/// </summary>
IACMPCAPaginatorFactory Paginators { get; }
#endif
#region CreateCertificateAuthority
/// <summary>
/// Creates a root or subordinate private certificate authority (CA). You must specify
/// the CA configuration, an optional configuration for Online Certificate Status Protocol
/// (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency
/// token to avoid accidental creation of multiple CAs. The CA configuration specifies
/// the name of the algorithm and key size to be used to create the CA private key, the
/// type of signing algorithm that the CA uses, and X.500 subject information. The OCSP
/// configuration can optionally specify a custom URL for the OCSP responder. The CRL
/// configuration specifies the CRL expiration period in days (the validity period of
/// the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the
/// S3 bucket that is included in certificates issued by the CA. If successful, this action
/// returns the Amazon Resource Name (ARN) of the CA.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting
/// Your CRLs</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthority service method.</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 CreateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority">REST API Reference for CreateCertificateAuthority Operation</seealso>
Task<CreateCertificateAuthorityResponse> CreateCertificateAuthorityAsync(CreateCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateCertificateAuthorityAuditReport
/// <summary>
/// Creates an audit report that lists every time that your CA private key is used. The
/// report is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// and <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// actions use the private key.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected
/// with encryption. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting
/// Your Audit Reports</a>.
/// </para>
/// <note>
/// <para>
/// You can generate a maximum of one report every 30 minutes.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreateCertificateAuthorityAuditReport service method.</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 CreateCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport">REST API Reference for CreateCertificateAuthorityAuditReport Operation</seealso>
Task<CreateCertificateAuthorityAuditReportResponse> CreateCertificateAuthorityAuditReportAsync(CreateCertificateAuthorityAuditReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreatePermission
/// <summary>
/// Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
/// principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
/// renew ACM certificates that reside in the same Amazon Web Services account as the
/// CA.
///
///
/// <para>
/// You can list current permissions with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action and revoke them with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the CreatePermission service method.</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 CreatePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.PermissionAlreadyExistsException">
/// The designated permission has already been given to the user.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission">REST API Reference for CreatePermission Operation</seealso>
Task<CreatePermissionResponse> CreatePermissionAsync(CreatePermissionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteCertificateAuthority
/// <summary>
/// Deletes a private certificate authority (CA). You must provide the Amazon Resource
/// Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
/// the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// action.
///
/// <note>
/// <para>
/// Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
/// </para>
/// </note>
/// <para>
/// Before you can delete a CA that you have created and activated, you must disable it.
/// To do this, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>.
///
/// </para>
///
/// <para>
/// Additionally, you can delete a CA if you are waiting for it to be created (that is,
/// the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
/// been created but you haven't yet imported the signed certificate into Amazon Web Services
/// Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>).
/// </para>
///
/// <para>
/// When you successfully call <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>,
/// the CA's status changes to <code>DELETED</code>. However, the CA won't be permanently
/// deleted until the restoration period has passed. By default, if you do not set the
/// <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for
/// 30 days. You can set the parameter from 7 to 30 days. The <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// action returns the time remaining in the restoration window of a private CA in the
/// <code>DELETED</code> state. To restore an eligible CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html">RestoreCertificateAuthority</a>
/// action.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeleteCertificateAuthority service method.</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 DeleteCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority">REST API Reference for DeleteCertificateAuthority Operation</seealso>
Task<DeleteCertificateAuthorityResponse> DeleteCertificateAuthorityAsync(DeleteCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeletePermission
/// <summary>
/// Revokes permissions on a private CA granted to the Certificate Manager (ACM) service
/// principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA. If you revoke these permissions, ACM will
/// no longer renew the affected certificates automatically.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and listed with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html">ListPermissions</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePermission service method.</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 DeletePermission service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission">REST API Reference for DeletePermission Operation</seealso>
Task<DeletePermissionResponse> DeletePermissionAsync(DeletePermissionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeletePolicy
/// <summary>
/// Deletes the resource-based policy attached to a private CA. Deletion will remove any
/// access that the policy has granted. If there is no policy attached to the private
/// CA, this action will return successful.
///
///
/// <para>
/// If you delete a policy that was applied through Amazon Web Services Resource Access
/// Manager (RAM), the CA will be removed from all shares in which it was included.
/// </para>
///
/// <para>
/// The Certificate Manager Service Linked Role that the policy supports is not affected
/// when you delete the policy.
/// </para>
///
/// <para>
/// The current policy can be shown with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</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 DeletePolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy">REST API Reference for DeletePolicy Operation</seealso>
Task<DeletePolicyResponse> DeletePolicyAsync(DeletePolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeCertificateAuthority
/// <summary>
/// Lists information about your private certificate authority (CA) or one that has been
/// shared with you. You specify the private CA on input by its ARN (Amazon Resource Name).
/// The output contains the status of your CA. This can be any of the following:
///
/// <ul> <li>
/// <para>
/// <code>CREATING</code> - Amazon Web Services Private CA is creating your private certificate
/// authority.
/// </para>
/// </li> <li>
/// <para>
/// <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your
/// Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign
/// your private CA CSR and then import it into Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>ACTIVE</code> - Your private CA is active.
/// </para>
/// </li> <li>
/// <para>
/// <code>DISABLED</code> - Your private CA has been disabled.
/// </para>
/// </li> <li>
/// <para>
/// <code>EXPIRED</code> - Your private CA certificate has expired.
/// </para>
/// </li> <li>
/// <para>
/// <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems
/// such a network outage or back-end Amazon Web Services failure or other errors. A failed
/// CA can never return to the pending state. You must create a new CA.
/// </para>
/// </li> <li>
/// <para>
/// <code>DELETED</code> - Your private CA is within the restoration period, after which
/// it is permanently deleted. The length of time remaining in the CA's restoration period
/// is also included in this action's output.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthority service method.</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 DescribeCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority">REST API Reference for DescribeCertificateAuthority Operation</seealso>
Task<DescribeCertificateAuthorityResponse> DescribeCertificateAuthorityAsync(DescribeCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeCertificateAuthorityAuditReport
/// <summary>
/// Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action. Audit information is created every time the certificate authority (CA) private
/// key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeCertificateAuthorityAuditReport service method.</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 DescribeCertificateAuthorityAuditReport service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport">REST API Reference for DescribeCertificateAuthorityAuditReport Operation</seealso>
Task<DescribeCertificateAuthorityAuditReportResponse> DescribeCertificateAuthorityAuditReportAsync(DescribeCertificateAuthorityAuditReportRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetCertificate
/// <summary>
/// Retrieves a certificate from your private CA or one that has been shared with you.
/// The ARN of the certificate is returned when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a>
/// action. You must specify both the ARN of your private CA and the ARN of the issued
/// certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate
/// if it is in the <b>ISSUED</b> state. You can call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>
/// action to create a report that contains information about all of the certificates
/// issued and revoked by your private CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificate service method.</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 GetCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate">REST API Reference for GetCertificate Operation</seealso>
Task<GetCertificateResponse> GetCertificateAsync(GetCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetCertificateAuthorityCertificate
/// <summary>
/// Retrieves the certificate and certificate chain for your private certificate authority
/// (CA) or one that has been shared with you. Both the certificate and the chain are
/// base64 PEM-encoded. The chain does not include the CA certificate. Each certificate
/// in the chain signs the one before it.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCertificate service method.</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 GetCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate">REST API Reference for GetCertificateAuthorityCertificate Operation</seealso>
Task<GetCertificateAuthorityCertificateResponse> GetCertificateAuthorityCertificateAsync(GetCertificateAuthorityCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetCertificateAuthorityCsr
/// <summary>
/// Retrieves the certificate signing request (CSR) for your private certificate authority
/// (CA). The CSR is created when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises
/// root or subordinate CA. Then import the signed certificate back into Amazon Web Services
/// Private CA by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action. The CSR is returned as a base64 PEM-encoded string.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetCertificateAuthorityCsr service method.</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 GetCertificateAuthorityCsr service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr">REST API Reference for GetCertificateAuthorityCsr Operation</seealso>
Task<GetCertificateAuthorityCsrResponse> GetCertificateAuthorityCsrAsync(GetCertificateAuthorityCsrRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetPolicy
/// <summary>
/// Retrieves the resource-based policy attached to a private CA. If either the private
/// CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>.
///
///
///
/// <para>
/// The policy can be attached or updated with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</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 GetPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy">REST API Reference for GetPolicy Operation</seealso>
Task<GetPolicyResponse> GetPolicyAsync(GetPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ImportCertificateAuthorityCertificate
/// <summary>
/// Imports a signed private CA certificate into Amazon Web Services Private CA. This
/// action is used when you are using a chain of trust whose root is located outside Amazon
/// Web Services Private CA. Before you can call this action, the following preparations
/// must in place:
///
/// <ol> <li>
/// <para>
/// In Amazon Web Services Private CA, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action to create the private CA that you plan to back with the imported certificate.
/// </para>
/// </li> <li>
/// <para>
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html">GetCertificateAuthorityCsr</a>
/// action to generate a certificate signing request (CSR).
/// </para>
/// </li> <li>
/// <para>
/// Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy
/// or by a commercial CA.
/// </para>
/// </li> <li>
/// <para>
/// Create a certificate chain and copy the signed certificate and the certificate chain
/// to your working directory.
/// </para>
/// </li> </ol>
/// <para>
/// Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
/// </para>
/// <ul> <li>
/// <para>
/// Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is hosted by Amazon
/// Web Services Private CA.
/// </para>
/// </li> <li>
/// <para>
/// Installing a subordinate CA certificate whose parent authority is externally hosted.
/// </para>
/// </li> </ul>
/// <para>
/// The following additional requirements apply when you import a CA certificate.
/// </para>
/// <ul> <li>
/// <para>
/// Only a self-signed certificate can be imported as a root CA.
/// </para>
/// </li> <li>
/// <para>
/// A self-signed certificate cannot be imported as a subordinate CA.
/// </para>
/// </li> <li>
/// <para>
/// Your certificate chain must not include the private CA certificate that you are importing.
/// </para>
/// </li> <li>
/// <para>
/// Your root CA must be the last certificate in your chain. The subordinate certificate,
/// if any, that your root CA signed must be next to last. The subordinate certificate
/// signed by the preceding subordinate CA must come next, and so on until your chain
/// is built.
/// </para>
/// </li> <li>
/// <para>
/// The chain must be PEM-encoded.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate is 32 KB.
/// </para>
/// </li> <li>
/// <para>
/// The maximum allowed size of a certificate chain is 2 MB.
/// </para>
/// </li> </ul>
/// <para>
/// <i>Enforcement of Critical Constraints</i>
/// </para>
///
/// <para>
/// Amazon Web Services Private CA allows the following extensions to be marked critical
/// in the imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Basic constraints (<i>must</i> be marked critical)
/// </para>
/// </li> <li>
/// <para>
/// Subject alternative names
/// </para>
/// </li> <li>
/// <para>
/// Key usage
/// </para>
/// </li> <li>
/// <para>
/// Extended key usage
/// </para>
/// </li> <li>
/// <para>
/// Authority key identifier
/// </para>
/// </li> <li>
/// <para>
/// Subject key identifier
/// </para>
/// </li> <li>
/// <para>
/// Issuer alternative name
/// </para>
/// </li> <li>
/// <para>
/// Subject directory attributes
/// </para>
/// </li> <li>
/// <para>
/// Subject information access
/// </para>
/// </li> <li>
/// <para>
/// Certificate policies
/// </para>
/// </li> <li>
/// <para>
/// Policy mappings
/// </para>
/// </li> <li>
/// <para>
/// Inhibit anyPolicy
/// </para>
/// </li> </ul>
/// <para>
/// Amazon Web Services Private CA rejects the following extensions when they are marked
/// critical in an imported CA certificate or chain.
/// </para>
/// <ul> <li>
/// <para>
/// Name constraints
/// </para>
/// </li> <li>
/// <para>
/// Policy constraints
/// </para>
/// </li> <li>
/// <para>
/// CRL distribution points
/// </para>
/// </li> <li>
/// <para>
/// Authority information access
/// </para>
/// </li> <li>
/// <para>
/// Freshest CRL
/// </para>
/// </li> <li>
/// <para>
/// Any other extension
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ImportCertificateAuthorityCertificate service method.</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 ImportCertificateAuthorityCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.CertificateMismatchException">
/// The certificate authority certificate you are importing does not comply with conditions
/// specified in the certificate that signed it.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCertificateException">
/// One or more fields in the certificate are invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate">REST API Reference for ImportCertificateAuthorityCertificate Operation</seealso>
Task<ImportCertificateAuthorityCertificateResponse> ImportCertificateAuthorityCertificateAsync(ImportCertificateAuthorityCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region IssueCertificate
/// <summary>
/// Uses your private certificate authority (CA), or one that has been shared with you,
/// to issue a client certificate. This action returns the Amazon Resource Name (ARN)
/// of the certificate. You can retrieve the certificate by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html">GetCertificate</a>
/// action and specifying the ARN.
///
/// <note>
/// <para>
/// You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs
/// of the certificates that you issue by using Amazon Web Services Private CA.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the IssueCertificate service method.</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 IssueCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.MalformedCSRException">
/// The certificate signing request is invalid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate">REST API Reference for IssueCertificate Operation</seealso>
Task<IssueCertificateResponse> IssueCertificateAsync(IssueCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListCertificateAuthorities
/// <summary>
/// Lists the private certificate authorities that you created by using the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html">CreateCertificateAuthority</a>
/// action.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListCertificateAuthorities service method.</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 ListCertificateAuthorities service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities">REST API Reference for ListCertificateAuthorities Operation</seealso>
Task<ListCertificateAuthoritiesResponse> ListCertificateAuthoritiesAsync(ListCertificateAuthoritiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListPermissions
/// <summary>
/// List all permissions on a private CA, if any, granted to the Certificate Manager (ACM)
/// service principal (acm.amazonaws.com).
///
///
/// <para>
/// These permissions allow ACM to issue and renew ACM certificates that reside in the
/// same Amazon Web Services account as the CA.
/// </para>
///
/// <para>
/// Permissions can be granted with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html">CreatePermission</a>
/// action and revoked with the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html">DeletePermission</a>
/// action.
/// </para>
/// <p class="title"> <b>About Permissions</b>
/// </para>
/// <ul> <li>
/// <para>
/// If the private CA and the certificates it issues reside in the same account, you can
/// use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic
/// certificate renewals.
/// </para>
/// </li> <li>
/// <para>
/// For automatic certificate renewal to succeed, the ACM service principal needs permissions
/// to create, retrieve, and list certificates.
/// </para>
/// </li> <li>
/// <para>
/// If the private CA and the ACM certificates reside in different accounts, then permissions
/// cannot be used to enable automatic renewals. Instead, the ACM certificate owner must
/// set up a resource-based policy to enable cross-account issuance and renewals. For
/// more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using
/// a Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListPermissions service method.</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 ListPermissions service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidNextTokenException">
/// The token specified in the <code>NextToken</code> argument is not valid. Use the token
/// returned from your previous call to <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions">REST API Reference for ListPermissions Operation</seealso>
Task<ListPermissionsResponse> ListPermissionsAsync(ListPermissionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTags
/// <summary>
/// Lists the tags, if any, that are associated with your private CA or one that has been
/// shared with you. Tags are labels that you can use to identify and organize your CAs.
/// Each tag consists of a key and an optional value. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>
/// action to add one or more tags to your CA. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action to remove tags.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListTags service method.</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 ListTags service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags">REST API Reference for ListTags Operation</seealso>
Task<ListTagsResponse> ListTagsAsync(ListTagsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutPolicy
/// <summary>
/// Attaches a resource-based policy to a private CA.
///
///
/// <para>
/// A policy can also be applied by sharing a private CA through Amazon Web Services Resource
/// Access Manager (RAM). For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
///
/// <para>
/// The policy can be displayed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html">GetPolicy</a>
/// and removed with <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html">DeletePolicy</a>.
/// </para>
/// <p class="title"> <b>About Policies</b>
/// </para>
/// <ul> <li>
/// <para>
/// A policy grants access on a private CA to an Amazon Web Services customer account,
/// to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit.
/// Policies are under the control of a CA administrator. For more information, see <a
/// href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html">Using a
/// Resource Based Policy with Amazon Web Services Private CA</a>.
/// </para>
/// </li> <li>
/// <para>
/// A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed
/// by a CA in another account.
/// </para>
/// </li> <li>
/// <para>
/// For ACM to manage automatic renewal of these certificates, the ACM user must configure
/// a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity
/// of the user, subject to confirmation against the Amazon Web Services Private CA policy.
/// For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using
/// a Service Linked Role with ACM</a>.
/// </para>
/// </li> <li>
/// <para>
/// Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html">Attach
/// a Policy for Cross-Account Access</a>.
/// </para>
/// </li> </ul>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the PutPolicy service method.</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 PutPolicy service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LockoutPreventedException">
/// The current action was prevented because it would lock the caller out from performing
/// subsequent actions. Verify that the specified parameters would not result in the caller
/// being denied access to the resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy">REST API Reference for PutPolicy Operation</seealso>
Task<PutPolicyResponse> PutPolicyAsync(PutPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RestoreCertificateAuthority
/// <summary>
/// Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You
/// can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b>
/// parameter of the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>
/// action. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b>
/// value, by default you can restore the CA at any time in a 30 day period. You can check
/// the time remaining in the restoration period of a private CA in the <code>DELETED</code>
/// state by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html">DescribeCertificateAuthority</a>
/// or <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a>
/// actions. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b>
/// action returns. To change its status to <code>ACTIVE</code>, call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a>
/// action. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion,
/// you must use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html">ImportCertificateAuthorityCertificate</a>
/// action to import a certificate authority into the private CA before it can be activated.
/// You cannot restore a CA after the restoration period has ended.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RestoreCertificateAuthority service method.</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 RestoreCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority">REST API Reference for RestoreCertificateAuthority Operation</seealso>
Task<RestoreCertificateAuthorityResponse> RestoreCertificateAuthorityAsync(RestoreCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RevokeCertificate
/// <summary>
/// Revokes a certificate that was issued inside Amazon Web Services Private CA. If you
/// enable a certificate revocation list (CRL) when you create or update your private
/// CA, information about the revoked certificates will be included in the CRL. Amazon
/// Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is
/// typically updated approximately 30 minutes after a certificate is revoked. If for
/// any reason the CRL update fails, Amazon Web Services Private CA attempts makes further
/// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
/// <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information,
/// see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html">Supported
/// CloudWatch Metrics</a>.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// <para>
/// Amazon Web Services Private CA also writes revocation information to the audit report.
/// For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a>.
/// </para>
/// <note>
/// <para>
/// You cannot revoke a root CA self-signed certificate.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RevokeCertificate service method.</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 RevokeCertificate service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidRequestException">
/// The request action cannot be performed or is prohibited.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.LimitExceededException">
/// An Amazon Web Services Private CA quota has been exceeded. See the exception message
/// returned to determine the quota that was exceeded.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestAlreadyProcessedException">
/// Your request has already been completed.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestFailedException">
/// The request has failed for an unspecified reason.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.RequestInProgressException">
/// Your request is already in progress.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate">REST API Reference for RevokeCertificate Operation</seealso>
Task<RevokeCertificateResponse> RevokeCertificateAsync(RevokeCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagCertificateAuthority
/// <summary>
/// Adds one or more tags to your private CA. Tags are labels that you can use to identify
/// and organize your Amazon Web Services resources. Each tag consists of a key and an
/// optional value. You specify the private CA on input by its Amazon Resource Name (ARN).
/// You specify the tag by using a key-value pair. You can apply a tag to just one private
/// CA if you want to identify a specific characteristic of that CA, or you can apply
/// the same tag to multiple private CAs if you want to filter for a common relationship
/// among those CAs. To remove one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a>
/// action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
///
/// <note>
/// <para>
/// To attach tags to a private CA during the creation procedure, a CA administrator must
/// first associate an inline IAM policy with the <code>CreateCertificateAuthority</code>
/// action and explicitly allow tagging. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching
/// tags to a CA at the time of creation</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the TagCertificateAuthority service method.</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 TagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.TooManyTagsException">
/// You can associate up to 50 tags with a private CA. Exception information is contained
/// in the exception message field.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority">REST API Reference for TagCertificateAuthority Operation</seealso>
Task<TagCertificateAuthorityResponse> TagCertificateAuthorityAsync(TagCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagCertificateAuthority
/// <summary>
/// Remove one or more tags from your private CA. A tag consists of a key-value pair.
/// If you do not specify the value portion of the tag when calling this action, the tag
/// will be removed regardless of value. If you specify a value, the tag is removed only
/// if it is associated with the specified value. To add tags to a private CA, use the
/// <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>.
/// Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a>
/// action to see what tags are associated with your CA.
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UntagCertificateAuthority service method.</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 UntagCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidTagException">
/// The tag associated with the CA is not valid. The invalid argument is contained in
/// the message field.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority">REST API Reference for UntagCertificateAuthority Operation</seealso>
Task<UntagCertificateAuthorityResponse> UntagCertificateAuthorityAsync(UntagCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateCertificateAuthority
/// <summary>
/// Updates the status or configuration of a private certificate authority (CA). Your
/// private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before
/// you can update it. You can disable a private CA that is in the <code>ACTIVE</code>
/// state or make a CA that is in the <code>DISABLED</code> state active again.
///
/// <note>
/// <para>
/// Both Amazon Web Services Private CA and the IAM principal must have permission to
/// write to the S3 bucket that you specify. If the IAM principal making the call does
/// not have permission to write to the bucket, then an exception is thrown. For more
/// information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
/// policies for CRLs in Amazon S3</a>.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the UpdateCertificateAuthority service method.</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 UpdateCertificateAuthority service method, as returned by ACMPCA.</returns>
/// <exception cref="Amazon.ACMPCA.Model.ConcurrentModificationException">
/// A previous update to your private CA is still ongoing.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArgsException">
/// One or more of the specified arguments was not valid.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidArnException">
/// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidPolicyException">
/// The resource policy is invalid or is missing a required statement. For general information
/// about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview
/// of JSON Policies</a>.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.InvalidStateException">
/// The state of the private CA does not allow this action to occur.
/// </exception>
/// <exception cref="Amazon.ACMPCA.Model.ResourceNotFoundException">
/// A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot
/// be found.
/// </exception>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority">REST API Reference for UpdateCertificateAuthority Operation</seealso>
Task<UpdateCertificateAuthorityResponse> UpdateCertificateAuthorityAsync(UpdateCertificateAuthorityRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
} | 1,484 |
aws-sdk-net | aws | C# | using System;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Runtime.CompilerServices;
// General Information about an assembly is controlled through the following
// set of attributes. Change these attribute values to modify the information
// associated with an assembly.
[assembly: AssemblyTitle("AWSSDK.ACMPCA")]
#if BCL35
[assembly: AssemblyDescription("The Amazon Web Services SDK for .NET (3.5) - AWS Certificate Manager Private Certificate Authority. AWS Certificate Manager (ACM) Private Certificate Authority (CA) is a managed private CA service that helps you easily and securely manage the lifecycle of your private certificates. ACM Private CA provides you a highly-available private CA service without the upfront investment and ongoing maintenance costs of operating your own private CA. ACM Private CA extends ACM's certificate management capabilities to private certificates, enabling you to manage public and private certificates centrally.")]
#elif BCL45
[assembly: AssemblyDescription("The Amazon Web Services SDK for .NET (4.5) - AWS Certificate Manager Private Certificate Authority. AWS Certificate Manager (ACM) Private Certificate Authority (CA) is a managed private CA service that helps you easily and securely manage the lifecycle of your private certificates. ACM Private CA provides you a highly-available private CA service without the upfront investment and ongoing maintenance costs of operating your own private CA. ACM Private CA extends ACM's certificate management capabilities to private certificates, enabling you to manage public and private certificates centrally.")]
#elif NETSTANDARD20
[assembly: AssemblyDescription("The Amazon Web Services SDK for .NET (NetStandard 2.0) - AWS Certificate Manager Private Certificate Authority. AWS Certificate Manager (ACM) Private Certificate Authority (CA) is a managed private CA service that helps you easily and securely manage the lifecycle of your private certificates. ACM Private CA provides you a highly-available private CA service without the upfront investment and ongoing maintenance costs of operating your own private CA. ACM Private CA extends ACM's certificate management capabilities to private certificates, enabling you to manage public and private certificates centrally.")]
#elif NETCOREAPP3_1
[assembly: AssemblyDescription("The Amazon Web Services SDK for .NET (.NET Core 3.1) - AWS Certificate Manager Private Certificate Authority. AWS Certificate Manager (ACM) Private Certificate Authority (CA) is a managed private CA service that helps you easily and securely manage the lifecycle of your private certificates. ACM Private CA provides you a highly-available private CA service without the upfront investment and ongoing maintenance costs of operating your own private CA. ACM Private CA extends ACM's certificate management capabilities to private certificates, enabling you to manage public and private certificates centrally.")]
#else
#error Unknown platform constant - unable to set correct AssemblyDescription
#endif
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyProduct("Amazon Web Services SDK for .NET")]
[assembly: AssemblyCompany("Amazon.com, Inc")]
[assembly: AssemblyCopyright("Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]
// Setting ComVisible to false makes the types in this assembly not visible
// to COM components. If you need to access a type in this assembly from
// COM, set the ComVisible attribute to true on that type.
[assembly: ComVisible(false)]
// Version information for an assembly consists of the following four values:
//
// Major Version
// Minor Version
// Build Number
// Revision
//
// You can specify all the values or you can default the Build and Revision Numbers
// by using the '*' as shown below:
// [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyVersion("3.3")]
[assembly: AssemblyFileVersion("3.7.102.98")]
[assembly: System.CLSCompliant(true)]
#if BCL
[assembly: System.Security.AllowPartiallyTrustedCallers]
#endif | 51 |
aws-sdk-net | aws | C# | /*
* 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.
*/
using System.Diagnostics.CodeAnalysis;
// Types names matching namespaces
[module: SuppressMessage("Microsoft.Naming", "CA1724:TypeNamesShouldNotMatchNamespaces", Scope = "type", Target = "Amazon.AlexaForBusiness.Model.Profile")]
| 22 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.normal.json service model.
*/
using System;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Util.Internal;
using Amazon.AlexaForBusiness.Internal;
namespace Amazon.AlexaForBusiness
{
/// <summary>
/// Configuration for accessing Amazon AlexaForBusiness service
/// </summary>
[AWSSignerType("v4")]
public partial class AmazonAlexaForBusinessConfig : ClientConfig
{
private static readonly string UserAgentString =
InternalSDKUtils.BuildUserAgentString("3.7.100.147");
private string _userAgent = UserAgentString;
/// <summary>
/// Default constructor
/// </summary>
public AmazonAlexaForBusinessConfig()
: base(new Amazon.Runtime.Internal.DefaultConfigurationProvider(AmazonAlexaForBusinessDefaultConfiguration.GetAllConfigurations()))
{
this.AuthenticationServiceName = "a4b";
this.EndpointProvider = new AmazonAlexaForBusinessEndpointProvider();
}
/// <summary>
/// The constant used to lookup in the region hash the endpoint.
/// </summary>
public override string RegionEndpointServiceName
{
get
{
return "a4b";
}
}
/// <summary>
/// Gets the ServiceVersion property.
/// </summary>
public override string ServiceVersion
{
get
{
return "2017-11-09";
}
}
/// <summary>
/// Gets the value of UserAgent property.
/// </summary>
public override string UserAgent
{
get
{
return _userAgent;
}
}
}
} | 83 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using Amazon.Runtime;
namespace Amazon.AlexaForBusiness
{
/// <summary>
/// Configuration for accessing Amazon AlexaForBusiness service
/// </summary>
public static class AmazonAlexaForBusinessDefaultConfiguration
{
/// <summary>
/// Collection of all <see cref="DefaultConfiguration"/>s supported by
/// AlexaForBusiness
/// </summary>
public static ReadOnlyCollection<IDefaultConfiguration> GetAllConfigurations()
{
return new ReadOnlyCollection<IDefaultConfiguration>(new List<IDefaultConfiguration>
{
Standard,
InRegion,
CrossRegion,
Mobile,
Auto,
Legacy
});
}
/// <summary>
/// <p>The STANDARD mode provides the latest recommended default values that should be safe to run in most scenarios</p><p>Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK</p>
/// </summary>
public static IDefaultConfiguration Standard {get;} = new DefaultConfiguration
{
Name = DefaultConfigurationMode.Standard,
RetryMode = RequestRetryMode.Standard,
StsRegionalEndpoints = StsRegionalEndpointsValue.Regional,
S3UsEast1RegionalEndpoint = S3UsEast1RegionalEndpointValue.Regional,
// 0:00:03.1
ConnectTimeout = TimeSpan.FromMilliseconds(3100L),
// 0:00:03.1
TlsNegotiationTimeout = TimeSpan.FromMilliseconds(3100L),
TimeToFirstByteTimeout = null,
HttpRequestTimeout = null
};
/// <summary>
/// <p>The IN_REGION mode builds on the standard mode and includes optimization tailored for applications which call AWS services from within the same AWS region</p><p>Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK</p>
/// </summary>
public static IDefaultConfiguration InRegion {get;} = new DefaultConfiguration
{
Name = DefaultConfigurationMode.InRegion,
RetryMode = RequestRetryMode.Standard,
StsRegionalEndpoints = StsRegionalEndpointsValue.Regional,
S3UsEast1RegionalEndpoint = S3UsEast1RegionalEndpointValue.Regional,
// 0:00:01.1
ConnectTimeout = TimeSpan.FromMilliseconds(1100L),
// 0:00:01.1
TlsNegotiationTimeout = TimeSpan.FromMilliseconds(1100L),
TimeToFirstByteTimeout = null,
HttpRequestTimeout = null
};
/// <summary>
/// <p>The CROSS_REGION mode builds on the standard mode and includes optimization tailored for applications which call AWS services in a different region</p><p>Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK</p>
/// </summary>
public static IDefaultConfiguration CrossRegion {get;} = new DefaultConfiguration
{
Name = DefaultConfigurationMode.CrossRegion,
RetryMode = RequestRetryMode.Standard,
StsRegionalEndpoints = StsRegionalEndpointsValue.Regional,
S3UsEast1RegionalEndpoint = S3UsEast1RegionalEndpointValue.Regional,
// 0:00:03.1
ConnectTimeout = TimeSpan.FromMilliseconds(3100L),
// 0:00:03.1
TlsNegotiationTimeout = TimeSpan.FromMilliseconds(3100L),
TimeToFirstByteTimeout = null,
HttpRequestTimeout = null
};
/// <summary>
/// <p>The MOBILE mode builds on the standard mode and includes optimization tailored for mobile applications</p><p>Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK</p>
/// </summary>
public static IDefaultConfiguration Mobile {get;} = new DefaultConfiguration
{
Name = DefaultConfigurationMode.Mobile,
RetryMode = RequestRetryMode.Standard,
StsRegionalEndpoints = StsRegionalEndpointsValue.Regional,
S3UsEast1RegionalEndpoint = S3UsEast1RegionalEndpointValue.Regional,
// 0:00:30
ConnectTimeout = TimeSpan.FromMilliseconds(30000L),
// 0:00:30
TlsNegotiationTimeout = TimeSpan.FromMilliseconds(30000L),
TimeToFirstByteTimeout = null,
HttpRequestTimeout = null
};
/// <summary>
/// <p>The AUTO mode is an experimental mode that builds on the standard mode. The SDK will attempt to discover the execution environment to determine the appropriate settings automatically.</p><p>Note that the auto detection is heuristics-based and does not guarantee 100% accuracy. STANDARD mode will be used if the execution environment cannot be determined. The auto detection might query <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html">EC2 Instance Metadata service</a>, which might introduce latency. Therefore we recommend choosing an explicit defaults_mode instead if startup latency is critical to your application</p>
/// </summary>
public static IDefaultConfiguration Auto {get;} = new DefaultConfiguration
{
Name = DefaultConfigurationMode.Auto,
RetryMode = RequestRetryMode.Standard,
StsRegionalEndpoints = StsRegionalEndpointsValue.Regional,
S3UsEast1RegionalEndpoint = S3UsEast1RegionalEndpointValue.Regional,
// 0:00:01.1
ConnectTimeout = TimeSpan.FromMilliseconds(1100L),
// 0:00:01.1
TlsNegotiationTimeout = TimeSpan.FromMilliseconds(1100L),
TimeToFirstByteTimeout = null,
HttpRequestTimeout = null
};
/// <summary>
/// <p>The LEGACY mode provides default settings that vary per SDK and were used prior to establishment of defaults_mode</p>
/// </summary>
public static IDefaultConfiguration Legacy {get;} = new DefaultConfiguration
{
Name = DefaultConfigurationMode.Legacy,
RetryMode = RequestRetryMode.Legacy,
StsRegionalEndpoints = StsRegionalEndpointsValue.Legacy,
S3UsEast1RegionalEndpoint = S3UsEast1RegionalEndpointValue.Legacy,
ConnectTimeout = null,
TlsNegotiationTimeout = null,
TimeToFirstByteTimeout = null,
HttpRequestTimeout = null
};
}
} | 146 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.normal.json service model.
*/
using Amazon.Runtime;
using Amazon.Runtime.Endpoints;
namespace Amazon.AlexaForBusiness.Endpoints
{
/// <summary>
/// Contains parameters used for resolving AlexaForBusiness endpoints
/// Parameters can be sourced from client config and service operations
/// Used by internal AlexaForBusinessEndpointProvider and AlexaForBusinessEndpointResolver
/// Can be used by custom EndpointProvider, see ClientConfig.EndpointProvider
/// </summary>
public class AlexaForBusinessEndpointParameters : EndpointParameters
{
/// <summary>
/// AlexaForBusinessEndpointParameters constructor
/// </summary>
public AlexaForBusinessEndpointParameters()
{
UseDualStack = false;
UseFIPS = false;
}
/// <summary>
/// Region parameter
/// </summary>
public string Region
{
get { return (string)this["Region"]; }
set { this["Region"] = value; }
}
/// <summary>
/// UseDualStack parameter
/// </summary>
public bool? UseDualStack
{
get { return (bool?)this["UseDualStack"]; }
set { this["UseDualStack"] = value; }
}
/// <summary>
/// UseFIPS parameter
/// </summary>
public bool? UseFIPS
{
get { return (bool?)this["UseFIPS"]; }
set { this["UseFIPS"] = value; }
}
/// <summary>
/// Endpoint parameter
/// </summary>
public string Endpoint
{
get { return (string)this["Endpoint"]; }
set { this["Endpoint"] = value; }
}
}
} | 78 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Net;
using System.Text;
using Amazon.Runtime;
namespace Amazon.AlexaForBusiness
{
///<summary>
/// Common exception for the AlexaForBusiness service.
/// </summary>
#if !NETSTANDARD
[Serializable]
#endif
public partial class AmazonAlexaForBusinessException : AmazonServiceException
{
/// <summary>
/// Construct instance of AmazonAlexaForBusinessException
/// </summary>
/// <param name="message"></param>
public AmazonAlexaForBusinessException(string message)
: base(message)
{
}
/// <summary>
/// Construct instance of AmazonAlexaForBusinessException
/// </summary>
/// <param name="message"></param>
/// <param name="innerException"></param>
public AmazonAlexaForBusinessException(string message, Exception innerException)
: base(message, innerException)
{
}
/// <summary>
/// Construct instance of AmazonAlexaForBusinessException
/// </summary>
/// <param name="innerException"></param>
public AmazonAlexaForBusinessException(Exception innerException)
: base(innerException.Message, innerException)
{
}
/// <summary>
/// Construct instance of AmazonAlexaForBusinessException
/// </summary>
/// <param name="message"></param>
/// <param name="errorType"></param>
/// <param name="errorCode"></param>
/// <param name="requestId"></param>
/// <param name="statusCode"></param>
public AmazonAlexaForBusinessException(string message, ErrorType errorType, string errorCode, string requestId, HttpStatusCode statusCode)
: base(message, errorType, errorCode, requestId, statusCode)
{
}
/// <summary>
/// Construct instance of AmazonAlexaForBusinessException
/// </summary>
/// <param name="message"></param>
/// <param name="innerException"></param>
/// <param name="errorType"></param>
/// <param name="errorCode"></param>
/// <param name="requestId"></param>
/// <param name="statusCode"></param>
public AmazonAlexaForBusinessException(string message, Exception innerException, ErrorType errorType, string errorCode, string requestId, HttpStatusCode statusCode)
: base(message, innerException, errorType, errorCode, requestId, statusCode)
{
}
#if !NETSTANDARD
/// <summary>
/// Constructs a new instance of the AmazonAlexaForBusinessException class with serialized data.
/// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception>
/// <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception>
protected AmazonAlexaForBusinessException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
: base(info, context)
{
}
#endif
}
} | 105 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.normal.json service model.
*/
using System;
using Amazon.Runtime;
namespace Amazon.AlexaForBusiness
{
/// <summary>
/// Constants used for properties of type BusinessReportFailureCode.
/// </summary>
public class BusinessReportFailureCode : ConstantClass
{
/// <summary>
/// Constant ACCESS_DENIED for BusinessReportFailureCode
/// </summary>
public static readonly BusinessReportFailureCode ACCESS_DENIED = new BusinessReportFailureCode("ACCESS_DENIED");
/// <summary>
/// Constant INTERNAL_FAILURE for BusinessReportFailureCode
/// </summary>
public static readonly BusinessReportFailureCode INTERNAL_FAILURE = new BusinessReportFailureCode("INTERNAL_FAILURE");
/// <summary>
/// Constant NO_SUCH_BUCKET for BusinessReportFailureCode
/// </summary>
public static readonly BusinessReportFailureCode NO_SUCH_BUCKET = new BusinessReportFailureCode("NO_SUCH_BUCKET");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public BusinessReportFailureCode(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static BusinessReportFailureCode FindValue(string value)
{
return FindValue<BusinessReportFailureCode>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator BusinessReportFailureCode(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type BusinessReportFormat.
/// </summary>
public class BusinessReportFormat : ConstantClass
{
/// <summary>
/// Constant CSV for BusinessReportFormat
/// </summary>
public static readonly BusinessReportFormat CSV = new BusinessReportFormat("CSV");
/// <summary>
/// Constant CSV_ZIP for BusinessReportFormat
/// </summary>
public static readonly BusinessReportFormat CSV_ZIP = new BusinessReportFormat("CSV_ZIP");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public BusinessReportFormat(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static BusinessReportFormat FindValue(string value)
{
return FindValue<BusinessReportFormat>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator BusinessReportFormat(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type BusinessReportInterval.
/// </summary>
public class BusinessReportInterval : ConstantClass
{
/// <summary>
/// Constant ONE_DAY for BusinessReportInterval
/// </summary>
public static readonly BusinessReportInterval ONE_DAY = new BusinessReportInterval("ONE_DAY");
/// <summary>
/// Constant ONE_WEEK for BusinessReportInterval
/// </summary>
public static readonly BusinessReportInterval ONE_WEEK = new BusinessReportInterval("ONE_WEEK");
/// <summary>
/// Constant THIRTY_DAYS for BusinessReportInterval
/// </summary>
public static readonly BusinessReportInterval THIRTY_DAYS = new BusinessReportInterval("THIRTY_DAYS");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public BusinessReportInterval(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static BusinessReportInterval FindValue(string value)
{
return FindValue<BusinessReportInterval>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator BusinessReportInterval(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type BusinessReportStatus.
/// </summary>
public class BusinessReportStatus : ConstantClass
{
/// <summary>
/// Constant FAILED for BusinessReportStatus
/// </summary>
public static readonly BusinessReportStatus FAILED = new BusinessReportStatus("FAILED");
/// <summary>
/// Constant RUNNING for BusinessReportStatus
/// </summary>
public static readonly BusinessReportStatus RUNNING = new BusinessReportStatus("RUNNING");
/// <summary>
/// Constant SUCCEEDED for BusinessReportStatus
/// </summary>
public static readonly BusinessReportStatus SUCCEEDED = new BusinessReportStatus("SUCCEEDED");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public BusinessReportStatus(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static BusinessReportStatus FindValue(string value)
{
return FindValue<BusinessReportStatus>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator BusinessReportStatus(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type CommsProtocol.
/// </summary>
public class CommsProtocol : ConstantClass
{
/// <summary>
/// Constant H323 for CommsProtocol
/// </summary>
public static readonly CommsProtocol H323 = new CommsProtocol("H323");
/// <summary>
/// Constant SIP for CommsProtocol
/// </summary>
public static readonly CommsProtocol SIP = new CommsProtocol("SIP");
/// <summary>
/// Constant SIPS for CommsProtocol
/// </summary>
public static readonly CommsProtocol SIPS = new CommsProtocol("SIPS");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public CommsProtocol(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static CommsProtocol FindValue(string value)
{
return FindValue<CommsProtocol>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator CommsProtocol(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type ConferenceProviderType.
/// </summary>
public class ConferenceProviderType : ConstantClass
{
/// <summary>
/// Constant BLUEJEANS for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType BLUEJEANS = new ConferenceProviderType("BLUEJEANS");
/// <summary>
/// Constant CHIME for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType CHIME = new ConferenceProviderType("CHIME");
/// <summary>
/// Constant CUSTOM for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType CUSTOM = new ConferenceProviderType("CUSTOM");
/// <summary>
/// Constant FUZE for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType FUZE = new ConferenceProviderType("FUZE");
/// <summary>
/// Constant GOOGLE_HANGOUTS for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType GOOGLE_HANGOUTS = new ConferenceProviderType("GOOGLE_HANGOUTS");
/// <summary>
/// Constant POLYCOM for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType POLYCOM = new ConferenceProviderType("POLYCOM");
/// <summary>
/// Constant RINGCENTRAL for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType RINGCENTRAL = new ConferenceProviderType("RINGCENTRAL");
/// <summary>
/// Constant SKYPE_FOR_BUSINESS for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType SKYPE_FOR_BUSINESS = new ConferenceProviderType("SKYPE_FOR_BUSINESS");
/// <summary>
/// Constant WEBEX for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType WEBEX = new ConferenceProviderType("WEBEX");
/// <summary>
/// Constant ZOOM for ConferenceProviderType
/// </summary>
public static readonly ConferenceProviderType ZOOM = new ConferenceProviderType("ZOOM");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public ConferenceProviderType(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static ConferenceProviderType FindValue(string value)
{
return FindValue<ConferenceProviderType>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator ConferenceProviderType(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type ConnectionStatus.
/// </summary>
public class ConnectionStatus : ConstantClass
{
/// <summary>
/// Constant OFFLINE for ConnectionStatus
/// </summary>
public static readonly ConnectionStatus OFFLINE = new ConnectionStatus("OFFLINE");
/// <summary>
/// Constant ONLINE for ConnectionStatus
/// </summary>
public static readonly ConnectionStatus ONLINE = new ConnectionStatus("ONLINE");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public ConnectionStatus(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static ConnectionStatus FindValue(string value)
{
return FindValue<ConnectionStatus>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator ConnectionStatus(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type DeviceEventType.
/// </summary>
public class DeviceEventType : ConstantClass
{
/// <summary>
/// Constant CONNECTION_STATUS for DeviceEventType
/// </summary>
public static readonly DeviceEventType CONNECTION_STATUS = new DeviceEventType("CONNECTION_STATUS");
/// <summary>
/// Constant DEVICE_STATUS for DeviceEventType
/// </summary>
public static readonly DeviceEventType DEVICE_STATUS = new DeviceEventType("DEVICE_STATUS");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public DeviceEventType(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static DeviceEventType FindValue(string value)
{
return FindValue<DeviceEventType>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator DeviceEventType(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type DeviceStatus.
/// </summary>
public class DeviceStatus : ConstantClass
{
/// <summary>
/// Constant DEREGISTERED for DeviceStatus
/// </summary>
public static readonly DeviceStatus DEREGISTERED = new DeviceStatus("DEREGISTERED");
/// <summary>
/// Constant FAILED for DeviceStatus
/// </summary>
public static readonly DeviceStatus FAILED = new DeviceStatus("FAILED");
/// <summary>
/// Constant PENDING for DeviceStatus
/// </summary>
public static readonly DeviceStatus PENDING = new DeviceStatus("PENDING");
/// <summary>
/// Constant READY for DeviceStatus
/// </summary>
public static readonly DeviceStatus READY = new DeviceStatus("READY");
/// <summary>
/// Constant WAS_OFFLINE for DeviceStatus
/// </summary>
public static readonly DeviceStatus WAS_OFFLINE = new DeviceStatus("WAS_OFFLINE");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public DeviceStatus(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static DeviceStatus FindValue(string value)
{
return FindValue<DeviceStatus>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator DeviceStatus(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type DeviceStatusDetailCode.
/// </summary>
public class DeviceStatusDetailCode : ConstantClass
{
/// <summary>
/// Constant ASSOCIATION_REJECTION for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode ASSOCIATION_REJECTION = new DeviceStatusDetailCode("ASSOCIATION_REJECTION");
/// <summary>
/// Constant AUTHENTICATION_FAILURE for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode AUTHENTICATION_FAILURE = new DeviceStatusDetailCode("AUTHENTICATION_FAILURE");
/// <summary>
/// Constant CERTIFICATE_AUTHORITY_ACCESS_DENIED for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode CERTIFICATE_AUTHORITY_ACCESS_DENIED = new DeviceStatusDetailCode("CERTIFICATE_AUTHORITY_ACCESS_DENIED");
/// <summary>
/// Constant CERTIFICATE_ISSUING_LIMIT_EXCEEDED for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode CERTIFICATE_ISSUING_LIMIT_EXCEEDED = new DeviceStatusDetailCode("CERTIFICATE_ISSUING_LIMIT_EXCEEDED");
/// <summary>
/// Constant CREDENTIALS_ACCESS_FAILURE for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode CREDENTIALS_ACCESS_FAILURE = new DeviceStatusDetailCode("CREDENTIALS_ACCESS_FAILURE");
/// <summary>
/// Constant DEVICE_SOFTWARE_UPDATE_NEEDED for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode DEVICE_SOFTWARE_UPDATE_NEEDED = new DeviceStatusDetailCode("DEVICE_SOFTWARE_UPDATE_NEEDED");
/// <summary>
/// Constant DEVICE_WAS_OFFLINE for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode DEVICE_WAS_OFFLINE = new DeviceStatusDetailCode("DEVICE_WAS_OFFLINE");
/// <summary>
/// Constant DHCP_FAILURE for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode DHCP_FAILURE = new DeviceStatusDetailCode("DHCP_FAILURE");
/// <summary>
/// Constant DNS_FAILURE for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode DNS_FAILURE = new DeviceStatusDetailCode("DNS_FAILURE");
/// <summary>
/// Constant INTERNET_UNAVAILABLE for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode INTERNET_UNAVAILABLE = new DeviceStatusDetailCode("INTERNET_UNAVAILABLE");
/// <summary>
/// Constant INVALID_CERTIFICATE_AUTHORITY for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode INVALID_CERTIFICATE_AUTHORITY = new DeviceStatusDetailCode("INVALID_CERTIFICATE_AUTHORITY");
/// <summary>
/// Constant INVALID_PASSWORD_STATE for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode INVALID_PASSWORD_STATE = new DeviceStatusDetailCode("INVALID_PASSWORD_STATE");
/// <summary>
/// Constant NETWORK_PROFILE_NOT_FOUND for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode NETWORK_PROFILE_NOT_FOUND = new DeviceStatusDetailCode("NETWORK_PROFILE_NOT_FOUND");
/// <summary>
/// Constant PASSWORD_MANAGER_ACCESS_DENIED for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode PASSWORD_MANAGER_ACCESS_DENIED = new DeviceStatusDetailCode("PASSWORD_MANAGER_ACCESS_DENIED");
/// <summary>
/// Constant PASSWORD_NOT_FOUND for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode PASSWORD_NOT_FOUND = new DeviceStatusDetailCode("PASSWORD_NOT_FOUND");
/// <summary>
/// Constant TLS_VERSION_MISMATCH for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode TLS_VERSION_MISMATCH = new DeviceStatusDetailCode("TLS_VERSION_MISMATCH");
/// <summary>
/// Constant UNKNOWN_FAILURE for DeviceStatusDetailCode
/// </summary>
public static readonly DeviceStatusDetailCode UNKNOWN_FAILURE = new DeviceStatusDetailCode("UNKNOWN_FAILURE");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public DeviceStatusDetailCode(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static DeviceStatusDetailCode FindValue(string value)
{
return FindValue<DeviceStatusDetailCode>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator DeviceStatusDetailCode(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type DeviceUsageType.
/// </summary>
public class DeviceUsageType : ConstantClass
{
/// <summary>
/// Constant VOICE for DeviceUsageType
/// </summary>
public static readonly DeviceUsageType VOICE = new DeviceUsageType("VOICE");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public DeviceUsageType(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static DeviceUsageType FindValue(string value)
{
return FindValue<DeviceUsageType>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator DeviceUsageType(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type DistanceUnit.
/// </summary>
public class DistanceUnit : ConstantClass
{
/// <summary>
/// Constant IMPERIAL for DistanceUnit
/// </summary>
public static readonly DistanceUnit IMPERIAL = new DistanceUnit("IMPERIAL");
/// <summary>
/// Constant METRIC for DistanceUnit
/// </summary>
public static readonly DistanceUnit METRIC = new DistanceUnit("METRIC");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public DistanceUnit(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static DistanceUnit FindValue(string value)
{
return FindValue<DistanceUnit>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator DistanceUnit(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type EnablementType.
/// </summary>
public class EnablementType : ConstantClass
{
/// <summary>
/// Constant ENABLED for EnablementType
/// </summary>
public static readonly EnablementType ENABLED = new EnablementType("ENABLED");
/// <summary>
/// Constant PENDING for EnablementType
/// </summary>
public static readonly EnablementType PENDING = new EnablementType("PENDING");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public EnablementType(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static EnablementType FindValue(string value)
{
return FindValue<EnablementType>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator EnablementType(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type EnablementTypeFilter.
/// </summary>
public class EnablementTypeFilter : ConstantClass
{
/// <summary>
/// Constant ENABLED for EnablementTypeFilter
/// </summary>
public static readonly EnablementTypeFilter ENABLED = new EnablementTypeFilter("ENABLED");
/// <summary>
/// Constant PENDING for EnablementTypeFilter
/// </summary>
public static readonly EnablementTypeFilter PENDING = new EnablementTypeFilter("PENDING");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public EnablementTypeFilter(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static EnablementTypeFilter FindValue(string value)
{
return FindValue<EnablementTypeFilter>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator EnablementTypeFilter(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type EndOfMeetingReminderType.
/// </summary>
public class EndOfMeetingReminderType : ConstantClass
{
/// <summary>
/// Constant ANNOUNCEMENT_TIME_CHECK for EndOfMeetingReminderType
/// </summary>
public static readonly EndOfMeetingReminderType ANNOUNCEMENT_TIME_CHECK = new EndOfMeetingReminderType("ANNOUNCEMENT_TIME_CHECK");
/// <summary>
/// Constant ANNOUNCEMENT_VARIABLE_TIME_LEFT for EndOfMeetingReminderType
/// </summary>
public static readonly EndOfMeetingReminderType ANNOUNCEMENT_VARIABLE_TIME_LEFT = new EndOfMeetingReminderType("ANNOUNCEMENT_VARIABLE_TIME_LEFT");
/// <summary>
/// Constant CHIME for EndOfMeetingReminderType
/// </summary>
public static readonly EndOfMeetingReminderType CHIME = new EndOfMeetingReminderType("CHIME");
/// <summary>
/// Constant KNOCK for EndOfMeetingReminderType
/// </summary>
public static readonly EndOfMeetingReminderType KNOCK = new EndOfMeetingReminderType("KNOCK");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public EndOfMeetingReminderType(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static EndOfMeetingReminderType FindValue(string value)
{
return FindValue<EndOfMeetingReminderType>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator EndOfMeetingReminderType(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type EnrollmentStatus.
/// </summary>
public class EnrollmentStatus : ConstantClass
{
/// <summary>
/// Constant DEREGISTERING for EnrollmentStatus
/// </summary>
public static readonly EnrollmentStatus DEREGISTERING = new EnrollmentStatus("DEREGISTERING");
/// <summary>
/// Constant DISASSOCIATING for EnrollmentStatus
/// </summary>
public static readonly EnrollmentStatus DISASSOCIATING = new EnrollmentStatus("DISASSOCIATING");
/// <summary>
/// Constant INITIALIZED for EnrollmentStatus
/// </summary>
public static readonly EnrollmentStatus INITIALIZED = new EnrollmentStatus("INITIALIZED");
/// <summary>
/// Constant PENDING for EnrollmentStatus
/// </summary>
public static readonly EnrollmentStatus PENDING = new EnrollmentStatus("PENDING");
/// <summary>
/// Constant REGISTERED for EnrollmentStatus
/// </summary>
public static readonly EnrollmentStatus REGISTERED = new EnrollmentStatus("REGISTERED");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public EnrollmentStatus(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static EnrollmentStatus FindValue(string value)
{
return FindValue<EnrollmentStatus>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator EnrollmentStatus(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type Feature.
/// </summary>
public class Feature : ConstantClass
{
/// <summary>
/// Constant ALL for Feature
/// </summary>
public static readonly Feature ALL = new Feature("ALL");
/// <summary>
/// Constant BLUETOOTH for Feature
/// </summary>
public static readonly Feature BLUETOOTH = new Feature("BLUETOOTH");
/// <summary>
/// Constant LISTS for Feature
/// </summary>
public static readonly Feature LISTS = new Feature("LISTS");
/// <summary>
/// Constant NETWORK_PROFILE for Feature
/// </summary>
public static readonly Feature NETWORK_PROFILE = new Feature("NETWORK_PROFILE");
/// <summary>
/// Constant NOTIFICATIONS for Feature
/// </summary>
public static readonly Feature NOTIFICATIONS = new Feature("NOTIFICATIONS");
/// <summary>
/// Constant SETTINGS for Feature
/// </summary>
public static readonly Feature SETTINGS = new Feature("SETTINGS");
/// <summary>
/// Constant SKILLS for Feature
/// </summary>
public static readonly Feature SKILLS = new Feature("SKILLS");
/// <summary>
/// Constant VOLUME for Feature
/// </summary>
public static readonly Feature VOLUME = new Feature("VOLUME");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public Feature(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static Feature FindValue(string value)
{
return FindValue<Feature>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator Feature(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type Locale.
/// </summary>
public class Locale : ConstantClass
{
/// <summary>
/// Constant EnUS for Locale
/// </summary>
public static readonly Locale EnUS = new Locale("en-US");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public Locale(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static Locale FindValue(string value)
{
return FindValue<Locale>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator Locale(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type NetworkEapMethod.
/// </summary>
public class NetworkEapMethod : ConstantClass
{
/// <summary>
/// Constant EAP_TLS for NetworkEapMethod
/// </summary>
public static readonly NetworkEapMethod EAP_TLS = new NetworkEapMethod("EAP_TLS");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public NetworkEapMethod(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static NetworkEapMethod FindValue(string value)
{
return FindValue<NetworkEapMethod>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator NetworkEapMethod(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type NetworkSecurityType.
/// </summary>
public class NetworkSecurityType : ConstantClass
{
/// <summary>
/// Constant OPEN for NetworkSecurityType
/// </summary>
public static readonly NetworkSecurityType OPEN = new NetworkSecurityType("OPEN");
/// <summary>
/// Constant WEP for NetworkSecurityType
/// </summary>
public static readonly NetworkSecurityType WEP = new NetworkSecurityType("WEP");
/// <summary>
/// Constant WPA_PSK for NetworkSecurityType
/// </summary>
public static readonly NetworkSecurityType WPA_PSK = new NetworkSecurityType("WPA_PSK");
/// <summary>
/// Constant WPA2_ENTERPRISE for NetworkSecurityType
/// </summary>
public static readonly NetworkSecurityType WPA2_ENTERPRISE = new NetworkSecurityType("WPA2_ENTERPRISE");
/// <summary>
/// Constant WPA2_PSK for NetworkSecurityType
/// </summary>
public static readonly NetworkSecurityType WPA2_PSK = new NetworkSecurityType("WPA2_PSK");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public NetworkSecurityType(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static NetworkSecurityType FindValue(string value)
{
return FindValue<NetworkSecurityType>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator NetworkSecurityType(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type PhoneNumberType.
/// </summary>
public class PhoneNumberType : ConstantClass
{
/// <summary>
/// Constant HOME for PhoneNumberType
/// </summary>
public static readonly PhoneNumberType HOME = new PhoneNumberType("HOME");
/// <summary>
/// Constant MOBILE for PhoneNumberType
/// </summary>
public static readonly PhoneNumberType MOBILE = new PhoneNumberType("MOBILE");
/// <summary>
/// Constant WORK for PhoneNumberType
/// </summary>
public static readonly PhoneNumberType WORK = new PhoneNumberType("WORK");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public PhoneNumberType(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static PhoneNumberType FindValue(string value)
{
return FindValue<PhoneNumberType>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator PhoneNumberType(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type RequirePin.
/// </summary>
public class RequirePin : ConstantClass
{
/// <summary>
/// Constant NO for RequirePin
/// </summary>
public static readonly RequirePin NO = new RequirePin("NO");
/// <summary>
/// Constant OPTIONAL for RequirePin
/// </summary>
public static readonly RequirePin OPTIONAL = new RequirePin("OPTIONAL");
/// <summary>
/// Constant YES for RequirePin
/// </summary>
public static readonly RequirePin YES = new RequirePin("YES");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public RequirePin(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static RequirePin FindValue(string value)
{
return FindValue<RequirePin>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator RequirePin(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type SipType.
/// </summary>
public class SipType : ConstantClass
{
/// <summary>
/// Constant WORK for SipType
/// </summary>
public static readonly SipType WORK = new SipType("WORK");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public SipType(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static SipType FindValue(string value)
{
return FindValue<SipType>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator SipType(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type SkillType.
/// </summary>
public class SkillType : ConstantClass
{
/// <summary>
/// Constant PRIVATE for SkillType
/// </summary>
public static readonly SkillType PRIVATE = new SkillType("PRIVATE");
/// <summary>
/// Constant PUBLIC for SkillType
/// </summary>
public static readonly SkillType PUBLIC = new SkillType("PUBLIC");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public SkillType(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static SkillType FindValue(string value)
{
return FindValue<SkillType>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator SkillType(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type SkillTypeFilter.
/// </summary>
public class SkillTypeFilter : ConstantClass
{
/// <summary>
/// Constant ALL for SkillTypeFilter
/// </summary>
public static readonly SkillTypeFilter ALL = new SkillTypeFilter("ALL");
/// <summary>
/// Constant PRIVATE for SkillTypeFilter
/// </summary>
public static readonly SkillTypeFilter PRIVATE = new SkillTypeFilter("PRIVATE");
/// <summary>
/// Constant PUBLIC for SkillTypeFilter
/// </summary>
public static readonly SkillTypeFilter PUBLIC = new SkillTypeFilter("PUBLIC");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public SkillTypeFilter(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static SkillTypeFilter FindValue(string value)
{
return FindValue<SkillTypeFilter>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator SkillTypeFilter(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type SortValue.
/// </summary>
public class SortValue : ConstantClass
{
/// <summary>
/// Constant ASC for SortValue
/// </summary>
public static readonly SortValue ASC = new SortValue("ASC");
/// <summary>
/// Constant DESC for SortValue
/// </summary>
public static readonly SortValue DESC = new SortValue("DESC");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public SortValue(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static SortValue FindValue(string value)
{
return FindValue<SortValue>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator SortValue(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type TemperatureUnit.
/// </summary>
public class TemperatureUnit : ConstantClass
{
/// <summary>
/// Constant CELSIUS for TemperatureUnit
/// </summary>
public static readonly TemperatureUnit CELSIUS = new TemperatureUnit("CELSIUS");
/// <summary>
/// Constant FAHRENHEIT for TemperatureUnit
/// </summary>
public static readonly TemperatureUnit FAHRENHEIT = new TemperatureUnit("FAHRENHEIT");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public TemperatureUnit(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static TemperatureUnit FindValue(string value)
{
return FindValue<TemperatureUnit>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator TemperatureUnit(string value)
{
return FindValue(value);
}
}
/// <summary>
/// Constants used for properties of type WakeWord.
/// </summary>
public class WakeWord : ConstantClass
{
/// <summary>
/// Constant ALEXA for WakeWord
/// </summary>
public static readonly WakeWord ALEXA = new WakeWord("ALEXA");
/// <summary>
/// Constant AMAZON for WakeWord
/// </summary>
public static readonly WakeWord AMAZON = new WakeWord("AMAZON");
/// <summary>
/// Constant COMPUTER for WakeWord
/// </summary>
public static readonly WakeWord COMPUTER = new WakeWord("COMPUTER");
/// <summary>
/// Constant ECHO for WakeWord
/// </summary>
public static readonly WakeWord ECHO = new WakeWord("ECHO");
/// <summary>
/// This constant constructor does not need to be called if the constant
/// you are attempting to use is already defined as a static instance of
/// this class.
/// This constructor should be used to construct constants that are not
/// defined as statics, for instance if attempting to use a feature that is
/// newer than the current version of the SDK.
/// </summary>
public WakeWord(string value)
: base(value)
{
}
/// <summary>
/// Finds the constant for the unique value.
/// </summary>
/// <param name="value">The unique value for the constant</param>
/// <returns>The constant for the unique value</returns>
public static WakeWord FindValue(string value)
{
return FindValue<WakeWord>(value);
}
/// <summary>
/// Utility method to convert strings to the constant class.
/// </summary>
/// <param name="value">The string value to convert to the constant class.</param>
/// <returns></returns>
public static implicit operator WakeWord(string value)
{
return FindValue(value);
}
}
} | 1,606 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.Runtime.Endpoints;
using static Amazon.Runtime.Internal.Endpoints.StandardLibrary.Fn;
namespace Amazon.AlexaForBusiness.Internal
{
/// <summary>
/// Amazon AlexaForBusiness endpoint provider.
/// Resolves endpoint for given set of AlexaForBusinessEndpointParameters.
/// Can throw AmazonClientException if endpoint resolution is unsuccessful.
/// </summary>
public class AmazonAlexaForBusinessEndpointProvider : IEndpointProvider
{
/// <summary>
/// Resolve endpoint for AlexaForBusinessEndpointParameters
/// </summary>
public Endpoint ResolveEndpoint(EndpointParameters parameters)
{
if (parameters == null)
throw new ArgumentNullException("parameters");
if (parameters["UseDualStack"] == null)
throw new AmazonClientException("UseDualStack parameter must be set for endpoint resolution");
if (parameters["UseFIPS"] == null)
throw new AmazonClientException("UseFIPS parameter must be set for endpoint resolution");
var refs = new Dictionary<string, object>()
{
["Region"] = parameters["Region"],
["UseDualStack"] = parameters["UseDualStack"],
["UseFIPS"] = parameters["UseFIPS"],
["Endpoint"] = parameters["Endpoint"],
};
if (IsSet(refs["Endpoint"]))
{
if (Equals(refs["UseFIPS"], true))
{
throw new AmazonClientException("Invalid Configuration: FIPS and custom endpoint are not supported");
}
if (Equals(refs["UseDualStack"], true))
{
throw new AmazonClientException("Invalid Configuration: Dualstack and custom endpoint are not supported");
}
return new Endpoint((string)refs["Endpoint"], InterpolateJson(@"", refs), InterpolateJson(@"", refs));
}
if (IsSet(refs["Region"]))
{
if ((refs["PartitionResult"] = Partition((string)refs["Region"])) != null)
{
if (Equals(refs["UseFIPS"], true) && Equals(refs["UseDualStack"], true))
{
if (Equals(true, GetAttr(refs["PartitionResult"], "supportsFIPS")) && Equals(true, GetAttr(refs["PartitionResult"], "supportsDualStack")))
{
return new Endpoint(Interpolate(@"https://a4b-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", refs), InterpolateJson(@"", refs), InterpolateJson(@"", refs));
}
throw new AmazonClientException("FIPS and DualStack are enabled, but this partition does not support one or both");
}
if (Equals(refs["UseFIPS"], true))
{
if (Equals(true, GetAttr(refs["PartitionResult"], "supportsFIPS")))
{
return new Endpoint(Interpolate(@"https://a4b-fips.{Region}.{PartitionResult#dnsSuffix}", refs), InterpolateJson(@"", refs), InterpolateJson(@"", refs));
}
throw new AmazonClientException("FIPS is enabled but this partition does not support FIPS");
}
if (Equals(refs["UseDualStack"], true))
{
if (Equals(true, GetAttr(refs["PartitionResult"], "supportsDualStack")))
{
return new Endpoint(Interpolate(@"https://a4b.{Region}.{PartitionResult#dualStackDnsSuffix}", refs), InterpolateJson(@"", refs), InterpolateJson(@"", refs));
}
throw new AmazonClientException("DualStack is enabled but this partition does not support DualStack");
}
return new Endpoint(Interpolate(@"https://a4b.{Region}.{PartitionResult#dnsSuffix}", refs), InterpolateJson(@"", refs), InterpolateJson(@"", refs));
}
}
throw new AmazonClientException("Invalid Configuration: Missing Region");
throw new AmazonClientException("Cannot resolve endpoint");
}
}
} | 103 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.normal.json service model.
*/
using System;
using Amazon.AlexaForBusiness.Model;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Endpoints;
using Amazon.Util;
using Amazon.AlexaForBusiness.Endpoints;
#pragma warning disable 1591
namespace Amazon.AlexaForBusiness.Internal
{
/// <summary>
/// Amazon AlexaForBusiness endpoint resolver.
/// Custom PipelineHandler responsible for resolving endpoint and setting authentication parameters for AlexaForBusiness service requests.
/// Collects values for AlexaForBusinessEndpointParameters and then tries to resolve endpoint by calling
/// ResolveEndpoint method on GlobalEndpoints.Provider if present, otherwise uses AlexaForBusinessEndpointProvider.
/// Responsible for setting authentication and http headers provided by resolved endpoint.
/// </summary>
public class AmazonAlexaForBusinessEndpointResolver : BaseEndpointResolver
{
protected override void ServiceSpecificHandler(IExecutionContext executionContext, EndpointParameters parameters)
{
InjectHostPrefix(executionContext.RequestContext);
}
protected override EndpointParameters MapEndpointsParameters(IRequestContext requestContext)
{
var config = (AmazonAlexaForBusinessConfig)requestContext.ClientConfig;
var result = new AlexaForBusinessEndpointParameters();
result.Region = config.RegionEndpoint?.SystemName;
result.UseDualStack = config.UseDualstackEndpoint;
result.UseFIPS = config.UseFIPSEndpoint;
result.Endpoint = config.ServiceURL;
// The region needs to be determined from the ServiceURL if not set.
var regionEndpoint = config.RegionEndpoint;
if (regionEndpoint == null && !string.IsNullOrEmpty(config.ServiceURL))
{
var regionName = AWSSDKUtils.DetermineRegion(config.ServiceURL);
result.Region = RegionEndpoint.GetBySystemName(regionName).SystemName;
}
// To support legacy endpoint overridding rules in the endpoints.json
if (result.Region == "us-east-1-regional")
{
result.Region = "us-east-1";
}
// Use AlternateEndpoint region override if set
if (requestContext.Request.AlternateEndpoint != null)
{
result.Region = requestContext.Request.AlternateEndpoint.SystemName;
}
// Assign staticContextParams and contextParam per operation
return result;
}
}
} | 83 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.normal.json service model.
*/
using Amazon.Runtime.Internal;
namespace Amazon.AlexaForBusiness.Internal
{
/// <summary>
/// Service metadata for Amazon AlexaForBusiness service
/// </summary>
public partial class AmazonAlexaForBusinessMetadata : IServiceMetadata
{
/// <summary>
/// Gets the value of the Service Id.
/// </summary>
public string ServiceId
{
get
{
return "Alexa For Business";
}
}
/// <summary>
/// Gets the dictionary that gives mapping of renamed operations
/// </summary>
public System.Collections.Generic.IDictionary<string, string> OperationNameMapping
{
get
{
return new System.Collections.Generic.Dictionary<string, string>(0)
{
};
}
}
}
} | 55 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// An address book with attributes.
/// </summary>
public partial class AddressBook
{
private string _addressBookArn;
private string _description;
private string _name;
/// <summary>
/// Gets and sets the property AddressBookArn.
/// <para>
/// The ARN of the address book.
/// </para>
/// </summary>
public string AddressBookArn
{
get { return this._addressBookArn; }
set { this._addressBookArn = value; }
}
// Check to see if AddressBookArn property is set
internal bool IsSetAddressBookArn()
{
return this._addressBookArn != null;
}
/// <summary>
/// Gets and sets the property Description.
/// <para>
/// The description of the address book.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=200)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
/// <summary>
/// Gets and sets the property Name.
/// <para>
/// The name of the address book.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
}
} | 97 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Information related to an address book.
/// </summary>
public partial class AddressBookData
{
private string _addressBookArn;
private string _description;
private string _name;
/// <summary>
/// Gets and sets the property AddressBookArn.
/// <para>
/// The ARN of the address book.
/// </para>
/// </summary>
public string AddressBookArn
{
get { return this._addressBookArn; }
set { this._addressBookArn = value; }
}
// Check to see if AddressBookArn property is set
internal bool IsSetAddressBookArn()
{
return this._addressBookArn != null;
}
/// <summary>
/// Gets and sets the property Description.
/// <para>
/// The description of the address book.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=200)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
/// <summary>
/// Gets and sets the property Name.
/// <para>
/// The name of the address book.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
}
} | 97 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// The resource being created already exists.
/// </summary>
#if !NETSTANDARD
[Serializable]
#endif
public partial class AlreadyExistsException : AmazonAlexaForBusinessException
{
/// <summary>
/// Constructs a new AlreadyExistsException with the specified error
/// message.
/// </summary>
/// <param name="message">
/// Describes the error encountered.
/// </param>
public AlreadyExistsException(string message)
: base(message) {}
/// <summary>
/// Construct instance of AlreadyExistsException
/// </summary>
/// <param name="message"></param>
/// <param name="innerException"></param>
public AlreadyExistsException(string message, Exception innerException)
: base(message, innerException) {}
/// <summary>
/// Construct instance of AlreadyExistsException
/// </summary>
/// <param name="innerException"></param>
public AlreadyExistsException(Exception innerException)
: base(innerException) {}
/// <summary>
/// Construct instance of AlreadyExistsException
/// </summary>
/// <param name="message"></param>
/// <param name="innerException"></param>
/// <param name="errorType"></param>
/// <param name="errorCode"></param>
/// <param name="requestId"></param>
/// <param name="statusCode"></param>
public AlreadyExistsException(string message, Exception innerException, ErrorType errorType, string errorCode, string requestId, HttpStatusCode statusCode)
: base(message, innerException, errorType, errorCode, requestId, statusCode) {}
/// <summary>
/// Construct instance of AlreadyExistsException
/// </summary>
/// <param name="message"></param>
/// <param name="errorType"></param>
/// <param name="errorCode"></param>
/// <param name="requestId"></param>
/// <param name="statusCode"></param>
public AlreadyExistsException(string message, ErrorType errorType, string errorCode, string requestId, HttpStatusCode statusCode)
: base(message, errorType, errorCode, requestId, statusCode) {}
#if !NETSTANDARD
/// <summary>
/// Constructs a new instance of the AlreadyExistsException class with serialized data.
/// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception>
/// <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception>
protected AlreadyExistsException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
: base(info, context)
{
}
/// <summary>
/// Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.
/// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is a null reference (Nothing in Visual Basic). </exception>
#if BCL35
[System.Security.Permissions.SecurityPermission(
System.Security.Permissions.SecurityAction.LinkDemand,
Flags = System.Security.Permissions.SecurityPermissionFlag.SerializationFormatter)]
#endif
[System.Security.SecurityCritical]
// These FxCop rules are giving false-positives for this method
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2134:MethodsMustOverrideWithConsistentTransparencyFxCopRule")]
public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
{
base.GetObjectData(info, context);
}
#endif
}
} | 124 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.normal.json service model.
*/
using Amazon.Runtime;
namespace Amazon.AlexaForBusiness
{
/// <summary>
/// Base class for AlexaForBusiness operation requests.
/// </summary>
public partial class AmazonAlexaForBusinessRequest : AmazonWebServiceRequest
{
}
} | 30 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the ApproveSkill operation.
/// Associates a skill with the organization under the customer's AWS account. If a skill
/// is private, the user implicitly accepts access to this skill during enablement.
/// </summary>
public partial class ApproveSkillRequest : AmazonAlexaForBusinessRequest
{
private string _skillId;
/// <summary>
/// Gets and sets the property SkillId.
/// <para>
/// The unique identifier of the skill.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string SkillId
{
get { return this._skillId; }
set { this._skillId = value; }
}
// Check to see if SkillId property is set
internal bool IsSetSkillId()
{
return this._skillId != null;
}
}
} | 60 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the ApproveSkill operation.
/// </summary>
public partial class ApproveSkillResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the AssociateContactWithAddressBook operation.
/// Associates a contact with a given address book.
/// </summary>
public partial class AssociateContactWithAddressBookRequest : AmazonAlexaForBusinessRequest
{
private string _addressBookArn;
private string _contactArn;
/// <summary>
/// Gets and sets the property AddressBookArn.
/// <para>
/// The ARN of the address book with which to associate the contact.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string AddressBookArn
{
get { return this._addressBookArn; }
set { this._addressBookArn = value; }
}
// Check to see if AddressBookArn property is set
internal bool IsSetAddressBookArn()
{
return this._addressBookArn != null;
}
/// <summary>
/// Gets and sets the property ContactArn.
/// <para>
/// The ARN of the contact to associate with an address book.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string ContactArn
{
get { return this._contactArn; }
set { this._contactArn = value; }
}
// Check to see if ContactArn property is set
internal bool IsSetContactArn()
{
return this._contactArn != null;
}
}
} | 79 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the AssociateContactWithAddressBook operation.
/// </summary>
public partial class AssociateContactWithAddressBookResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the AssociateDeviceWithNetworkProfile operation.
/// Associates a device with the specified network profile.
/// </summary>
public partial class AssociateDeviceWithNetworkProfileRequest : AmazonAlexaForBusinessRequest
{
private string _deviceArn;
private string _networkProfileArn;
/// <summary>
/// Gets and sets the property DeviceArn.
/// <para>
/// The device ARN.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string DeviceArn
{
get { return this._deviceArn; }
set { this._deviceArn = value; }
}
// Check to see if DeviceArn property is set
internal bool IsSetDeviceArn()
{
return this._deviceArn != null;
}
/// <summary>
/// Gets and sets the property NetworkProfileArn.
/// <para>
/// The ARN of the network profile to associate with a device.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string NetworkProfileArn
{
get { return this._networkProfileArn; }
set { this._networkProfileArn = value; }
}
// Check to see if NetworkProfileArn property is set
internal bool IsSetNetworkProfileArn()
{
return this._networkProfileArn != null;
}
}
} | 79 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the AssociateDeviceWithNetworkProfile operation.
/// </summary>
public partial class AssociateDeviceWithNetworkProfileResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the AssociateDeviceWithRoom operation.
/// Associates a device with a given room. This applies all the settings from the room
/// profile to the device, and all the skills in any skill groups added to that room.
/// This operation requires the device to be online, or else a manual sync is required.
/// </summary>
public partial class AssociateDeviceWithRoomRequest : AmazonAlexaForBusinessRequest
{
private string _deviceArn;
private string _roomArn;
/// <summary>
/// Gets and sets the property DeviceArn.
/// <para>
/// The ARN of the device to associate to a room. Required.
/// </para>
/// </summary>
public string DeviceArn
{
get { return this._deviceArn; }
set { this._deviceArn = value; }
}
// Check to see if DeviceArn property is set
internal bool IsSetDeviceArn()
{
return this._deviceArn != null;
}
/// <summary>
/// Gets and sets the property RoomArn.
/// <para>
/// The ARN of the room with which to associate the device. Required.
/// </para>
/// </summary>
public string RoomArn
{
get { return this._roomArn; }
set { this._roomArn = value; }
}
// Check to see if RoomArn property is set
internal bool IsSetRoomArn()
{
return this._roomArn != null;
}
}
} | 79 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the AssociateDeviceWithRoom operation.
/// </summary>
public partial class AssociateDeviceWithRoomResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the AssociateSkillGroupWithRoom operation.
/// Associates a skill group with a given room. This enables all skills in the associated
/// skill group on all devices in the room.
/// </summary>
public partial class AssociateSkillGroupWithRoomRequest : AmazonAlexaForBusinessRequest
{
private string _roomArn;
private string _skillGroupArn;
/// <summary>
/// Gets and sets the property RoomArn.
/// <para>
/// The ARN of the room with which to associate the skill group. Required.
/// </para>
/// </summary>
public string RoomArn
{
get { return this._roomArn; }
set { this._roomArn = value; }
}
// Check to see if RoomArn property is set
internal bool IsSetRoomArn()
{
return this._roomArn != null;
}
/// <summary>
/// Gets and sets the property SkillGroupArn.
/// <para>
/// The ARN of the skill group to associate with a room. Required.
/// </para>
/// </summary>
public string SkillGroupArn
{
get { return this._skillGroupArn; }
set { this._skillGroupArn = value; }
}
// Check to see if SkillGroupArn property is set
internal bool IsSetSkillGroupArn()
{
return this._skillGroupArn != null;
}
}
} | 78 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the AssociateSkillGroupWithRoom operation.
/// </summary>
public partial class AssociateSkillGroupWithRoomResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the AssociateSkillWithSkillGroup operation.
/// Associates a skill with a skill group.
/// </summary>
public partial class AssociateSkillWithSkillGroupRequest : AmazonAlexaForBusinessRequest
{
private string _skillGroupArn;
private string _skillId;
/// <summary>
/// Gets and sets the property SkillGroupArn.
/// <para>
/// The ARN of the skill group to associate the skill to. Required.
/// </para>
/// </summary>
public string SkillGroupArn
{
get { return this._skillGroupArn; }
set { this._skillGroupArn = value; }
}
// Check to see if SkillGroupArn property is set
internal bool IsSetSkillGroupArn()
{
return this._skillGroupArn != null;
}
/// <summary>
/// Gets and sets the property SkillId.
/// <para>
/// The unique identifier of the skill.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string SkillId
{
get { return this._skillId; }
set { this._skillId = value; }
}
// Check to see if SkillId property is set
internal bool IsSetSkillId()
{
return this._skillId != null;
}
}
} | 78 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the AssociateSkillWithSkillGroup operation.
/// </summary>
public partial class AssociateSkillWithSkillGroupResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the AssociateSkillWithUsers operation.
/// Makes a private skill available for enrolled users to enable on their devices.
/// </summary>
public partial class AssociateSkillWithUsersRequest : AmazonAlexaForBusinessRequest
{
private string _skillId;
/// <summary>
/// Gets and sets the property SkillId.
/// <para>
/// The private skill ID you want to make available to enrolled users.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string SkillId
{
get { return this._skillId; }
set { this._skillId = value; }
}
// Check to see if SkillId property is set
internal bool IsSetSkillId()
{
return this._skillId != null;
}
}
} | 59 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the AssociateSkillWithUsers operation.
/// </summary>
public partial class AssociateSkillWithUsersResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// The audio message. There is a 1 MB limit on the audio file input and the only supported
/// format is MP3. To convert your MP3 audio files to an Alexa-friendly,
///
///
/// <para>
/// required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter
/// software. One option for this is a command-line tool, FFmpeg. For more information,
/// see <a href="https://www.ffmpeg.org/">FFmpeg</a>. The following command converts the
/// provided <input-file> to an MP3 file that is played in the announcement:
/// </para>
///
/// <para>
/// <code>ffmpeg -i <input-file> -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000 <output-file.mp3></code>
///
/// </para>
/// </summary>
public partial class Audio
{
private Locale _locale;
private string _location;
/// <summary>
/// Gets and sets the property Locale.
/// <para>
/// The locale of the audio message. Currently, en-US is supported.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public Locale Locale
{
get { return this._locale; }
set { this._locale = value; }
}
// Check to see if Locale property is set
internal bool IsSetLocale()
{
return this._locale != null;
}
/// <summary>
/// Gets and sets the property Location.
/// <para>
/// The location of the audio file. Currently, S3 URLs are supported. Only S3 locations
/// comprised of safe characters are valid. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#Safe%20Characters">Safe
/// Characters</a>.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=0, Max=1200)]
public string Location
{
get { return this._location; }
set { this._location = value; }
}
// Check to see if Location property is set
internal bool IsSetLocation()
{
return this._location != null;
}
}
} | 94 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Usage report with specified parameters.
/// </summary>
public partial class BusinessReport
{
private DateTime? _deliveryTime;
private string _downloadUrl;
private BusinessReportFailureCode _failureCode;
private BusinessReportS3Location _s3Location;
private BusinessReportStatus _status;
/// <summary>
/// Gets and sets the property DeliveryTime.
/// <para>
/// The time of report delivery.
/// </para>
/// </summary>
public DateTime DeliveryTime
{
get { return this._deliveryTime.GetValueOrDefault(); }
set { this._deliveryTime = value; }
}
// Check to see if DeliveryTime property is set
internal bool IsSetDeliveryTime()
{
return this._deliveryTime.HasValue;
}
/// <summary>
/// Gets and sets the property DownloadUrl.
/// <para>
/// The download link where a user can download the report.
/// </para>
/// </summary>
public string DownloadUrl
{
get { return this._downloadUrl; }
set { this._downloadUrl = value; }
}
// Check to see if DownloadUrl property is set
internal bool IsSetDownloadUrl()
{
return this._downloadUrl != null;
}
/// <summary>
/// Gets and sets the property FailureCode.
/// <para>
/// The failure code.
/// </para>
/// </summary>
public BusinessReportFailureCode FailureCode
{
get { return this._failureCode; }
set { this._failureCode = value; }
}
// Check to see if FailureCode property is set
internal bool IsSetFailureCode()
{
return this._failureCode != null;
}
/// <summary>
/// Gets and sets the property S3Location.
/// <para>
/// The S3 location of the output reports.
/// </para>
/// </summary>
public BusinessReportS3Location S3Location
{
get { return this._s3Location; }
set { this._s3Location = value; }
}
// Check to see if S3Location property is set
internal bool IsSetS3Location()
{
return this._s3Location != null;
}
/// <summary>
/// Gets and sets the property Status.
/// <para>
/// The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
/// </para>
/// </summary>
public BusinessReportStatus Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
}
} | 133 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// The content range of the report.
/// </summary>
public partial class BusinessReportContentRange
{
private BusinessReportInterval _interval;
/// <summary>
/// Gets and sets the property Interval.
/// <para>
/// The interval of the content range.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public BusinessReportInterval Interval
{
get { return this._interval; }
set { this._interval = value; }
}
// Check to see if Interval property is set
internal bool IsSetInterval()
{
return this._interval != null;
}
}
} | 58 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// The recurrence of the reports.
/// </summary>
public partial class BusinessReportRecurrence
{
private string _startDate;
/// <summary>
/// Gets and sets the property StartDate.
/// <para>
/// The start date.
/// </para>
/// </summary>
public string StartDate
{
get { return this._startDate; }
set { this._startDate = value; }
}
// Check to see if StartDate property is set
internal bool IsSetStartDate()
{
return this._startDate != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// The S3 location of the output reports.
/// </summary>
public partial class BusinessReportS3Location
{
private string _bucketName;
private string _path;
/// <summary>
/// Gets and sets the property BucketName.
/// <para>
/// The S3 bucket name of the output reports.
/// </para>
/// </summary>
public string BucketName
{
get { return this._bucketName; }
set { this._bucketName = value; }
}
// Check to see if BucketName property is set
internal bool IsSetBucketName()
{
return this._bucketName != null;
}
/// <summary>
/// Gets and sets the property Path.
/// <para>
/// The path of the business report.
/// </para>
/// </summary>
public string Path
{
get { return this._path; }
set { this._path = value; }
}
// Check to see if Path property is set
internal bool IsSetPath()
{
return this._path != null;
}
}
} | 76 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// The schedule of the usage report.
/// </summary>
public partial class BusinessReportSchedule
{
private BusinessReportContentRange _contentRange;
private BusinessReportFormat _format;
private BusinessReport _lastBusinessReport;
private BusinessReportRecurrence _recurrence;
private string _s3BucketName;
private string _s3KeyPrefix;
private string _scheduleArn;
private string _scheduleName;
/// <summary>
/// Gets and sets the property ContentRange.
/// <para>
/// The content range of the reports.
/// </para>
/// </summary>
public BusinessReportContentRange ContentRange
{
get { return this._contentRange; }
set { this._contentRange = value; }
}
// Check to see if ContentRange property is set
internal bool IsSetContentRange()
{
return this._contentRange != null;
}
/// <summary>
/// Gets and sets the property Format.
/// <para>
/// The format of the generated report (individual CSV files or zipped files of individual
/// files).
/// </para>
/// </summary>
public BusinessReportFormat Format
{
get { return this._format; }
set { this._format = value; }
}
// Check to see if Format property is set
internal bool IsSetFormat()
{
return this._format != null;
}
/// <summary>
/// Gets and sets the property LastBusinessReport.
/// <para>
/// The details of the last business report delivery for a specified time interval.
/// </para>
/// </summary>
public BusinessReport LastBusinessReport
{
get { return this._lastBusinessReport; }
set { this._lastBusinessReport = value; }
}
// Check to see if LastBusinessReport property is set
internal bool IsSetLastBusinessReport()
{
return this._lastBusinessReport != null;
}
/// <summary>
/// Gets and sets the property Recurrence.
/// <para>
/// The recurrence of the reports.
/// </para>
/// </summary>
public BusinessReportRecurrence Recurrence
{
get { return this._recurrence; }
set { this._recurrence = value; }
}
// Check to see if Recurrence property is set
internal bool IsSetRecurrence()
{
return this._recurrence != null;
}
/// <summary>
/// Gets and sets the property S3BucketName.
/// <para>
/// The S3 bucket name of the output reports.
/// </para>
/// </summary>
public string S3BucketName
{
get { return this._s3BucketName; }
set { this._s3BucketName = value; }
}
// Check to see if S3BucketName property is set
internal bool IsSetS3BucketName()
{
return this._s3BucketName != null;
}
/// <summary>
/// Gets and sets the property S3KeyPrefix.
/// <para>
/// The S3 key where the report is delivered.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=100)]
public string S3KeyPrefix
{
get { return this._s3KeyPrefix; }
set { this._s3KeyPrefix = value; }
}
// Check to see if S3KeyPrefix property is set
internal bool IsSetS3KeyPrefix()
{
return this._s3KeyPrefix != null;
}
/// <summary>
/// Gets and sets the property ScheduleArn.
/// <para>
/// The ARN of the business report schedule.
/// </para>
/// </summary>
public string ScheduleArn
{
get { return this._scheduleArn; }
set { this._scheduleArn = value; }
}
// Check to see if ScheduleArn property is set
internal bool IsSetScheduleArn()
{
return this._scheduleArn != null;
}
/// <summary>
/// Gets and sets the property ScheduleName.
/// <para>
/// The name identifier of the schedule.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=64)]
public string ScheduleName
{
get { return this._scheduleName; }
set { this._scheduleName = value; }
}
// Check to see if ScheduleName property is set
internal bool IsSetScheduleName()
{
return this._scheduleName != null;
}
}
} | 193 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// The skill store category that is shown. Alexa skills are assigned a specific skill
/// category during creation, such as News, Social, and Sports.
/// </summary>
public partial class Category
{
private long? _categoryId;
private string _categoryName;
/// <summary>
/// Gets and sets the property CategoryId.
/// <para>
/// The ID of the skill store category.
/// </para>
/// </summary>
[AWSProperty(Min=1)]
public long CategoryId
{
get { return this._categoryId.GetValueOrDefault(); }
set { this._categoryId = value; }
}
// Check to see if CategoryId property is set
internal bool IsSetCategoryId()
{
return this._categoryId.HasValue;
}
/// <summary>
/// Gets and sets the property CategoryName.
/// <para>
/// The name of the skill store category.
/// </para>
/// </summary>
public string CategoryName
{
get { return this._categoryName; }
set { this._categoryName = value; }
}
// Check to see if CategoryName property is set
internal bool IsSetCategoryName()
{
return this._categoryName != null;
}
}
} | 78 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// There is a concurrent modification of resources.
/// </summary>
#if !NETSTANDARD
[Serializable]
#endif
public partial class ConcurrentModificationException : AmazonAlexaForBusinessException
{
/// <summary>
/// Constructs a new ConcurrentModificationException with the specified error
/// message.
/// </summary>
/// <param name="message">
/// Describes the error encountered.
/// </param>
public ConcurrentModificationException(string message)
: base(message) {}
/// <summary>
/// Construct instance of ConcurrentModificationException
/// </summary>
/// <param name="message"></param>
/// <param name="innerException"></param>
public ConcurrentModificationException(string message, Exception innerException)
: base(message, innerException) {}
/// <summary>
/// Construct instance of ConcurrentModificationException
/// </summary>
/// <param name="innerException"></param>
public ConcurrentModificationException(Exception innerException)
: base(innerException) {}
/// <summary>
/// Construct instance of ConcurrentModificationException
/// </summary>
/// <param name="message"></param>
/// <param name="innerException"></param>
/// <param name="errorType"></param>
/// <param name="errorCode"></param>
/// <param name="requestId"></param>
/// <param name="statusCode"></param>
public ConcurrentModificationException(string message, Exception innerException, ErrorType errorType, string errorCode, string requestId, HttpStatusCode statusCode)
: base(message, innerException, errorType, errorCode, requestId, statusCode) {}
/// <summary>
/// Construct instance of ConcurrentModificationException
/// </summary>
/// <param name="message"></param>
/// <param name="errorType"></param>
/// <param name="errorCode"></param>
/// <param name="requestId"></param>
/// <param name="statusCode"></param>
public ConcurrentModificationException(string message, ErrorType errorType, string errorCode, string requestId, HttpStatusCode statusCode)
: base(message, errorType, errorCode, requestId, statusCode) {}
#if !NETSTANDARD
/// <summary>
/// Constructs a new instance of the ConcurrentModificationException class with serialized data.
/// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception>
/// <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception>
protected ConcurrentModificationException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
: base(info, context)
{
}
/// <summary>
/// Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.
/// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is a null reference (Nothing in Visual Basic). </exception>
#if BCL35
[System.Security.Permissions.SecurityPermission(
System.Security.Permissions.SecurityAction.LinkDemand,
Flags = System.Security.Permissions.SecurityPermissionFlag.SerializationFormatter)]
#endif
[System.Security.SecurityCritical]
// These FxCop rules are giving false-positives for this method
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Security", "CA2134:MethodsMustOverrideWithConsistentTransparencyFxCopRule")]
public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
{
base.GetObjectData(info, context);
}
#endif
}
} | 124 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// The default conference provider that is used if no other scheduled meetings are detected.
/// </summary>
public partial class ConferencePreference
{
private string _defaultConferenceProviderArn;
/// <summary>
/// Gets and sets the property DefaultConferenceProviderArn.
/// <para>
/// The ARN of the default conference provider.
/// </para>
/// </summary>
public string DefaultConferenceProviderArn
{
get { return this._defaultConferenceProviderArn; }
set { this._defaultConferenceProviderArn = value; }
}
// Check to see if DefaultConferenceProviderArn property is set
internal bool IsSetDefaultConferenceProviderArn()
{
return this._defaultConferenceProviderArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// An entity that provides a conferencing solution. Alexa for Business acts as the voice
/// interface and mediator that connects users to their preferred conference provider.
/// Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.
/// </summary>
public partial class ConferenceProvider
{
private string _arn;
private IPDialIn _ipDialIn;
private MeetingSetting _meetingSetting;
private string _name;
private PSTNDialIn _pstnDialIn;
private ConferenceProviderType _type;
/// <summary>
/// Gets and sets the property Arn.
/// <para>
/// The ARN of the newly created conference provider.
/// </para>
/// </summary>
public string Arn
{
get { return this._arn; }
set { this._arn = value; }
}
// Check to see if Arn property is set
internal bool IsSetArn()
{
return this._arn != null;
}
/// <summary>
/// Gets and sets the property IPDialIn.
/// <para>
/// The IP endpoint and protocol for calling.
/// </para>
/// </summary>
public IPDialIn IPDialIn
{
get { return this._ipDialIn; }
set { this._ipDialIn = value; }
}
// Check to see if IPDialIn property is set
internal bool IsSetIPDialIn()
{
return this._ipDialIn != null;
}
/// <summary>
/// Gets and sets the property MeetingSetting.
/// <para>
/// The meeting settings for the conference provider.
/// </para>
/// </summary>
public MeetingSetting MeetingSetting
{
get { return this._meetingSetting; }
set { this._meetingSetting = value; }
}
// Check to see if MeetingSetting property is set
internal bool IsSetMeetingSetting()
{
return this._meetingSetting != null;
}
/// <summary>
/// Gets and sets the property Name.
/// <para>
/// The name of the conference provider.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=50)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
/// <summary>
/// Gets and sets the property PSTNDialIn.
/// <para>
/// The information for PSTN conferencing.
/// </para>
/// </summary>
public PSTNDialIn PSTNDialIn
{
get { return this._pstnDialIn; }
set { this._pstnDialIn = value; }
}
// Check to see if PSTNDialIn property is set
internal bool IsSetPSTNDialIn()
{
return this._pstnDialIn != null;
}
/// <summary>
/// Gets and sets the property Type.
/// <para>
/// The type of conference providers.
/// </para>
/// </summary>
public ConferenceProviderType Type
{
get { return this._type; }
set { this._type = value; }
}
// Check to see if Type property is set
internal bool IsSetType()
{
return this._type != null;
}
}
} | 155 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// A contact with attributes.
/// </summary>
public partial class Contact
{
private string _contactArn;
private string _displayName;
private string _firstName;
private string _lastName;
private string _phoneNumber;
private List<PhoneNumber> _phoneNumbers = new List<PhoneNumber>();
private List<SipAddress> _sipAddresses = new List<SipAddress>();
/// <summary>
/// Gets and sets the property ContactArn.
/// <para>
/// The ARN of the contact.
/// </para>
/// </summary>
public string ContactArn
{
get { return this._contactArn; }
set { this._contactArn = value; }
}
// Check to see if ContactArn property is set
internal bool IsSetContactArn()
{
return this._contactArn != null;
}
/// <summary>
/// Gets and sets the property DisplayName.
/// <para>
/// The name of the contact to display on the console.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string DisplayName
{
get { return this._displayName; }
set { this._displayName = value; }
}
// Check to see if DisplayName property is set
internal bool IsSetDisplayName()
{
return this._displayName != null;
}
/// <summary>
/// Gets and sets the property FirstName.
/// <para>
/// The first name of the contact, used to call the contact on the device.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string FirstName
{
get { return this._firstName; }
set { this._firstName = value; }
}
// Check to see if FirstName property is set
internal bool IsSetFirstName()
{
return this._firstName != null;
}
/// <summary>
/// Gets and sets the property LastName.
/// <para>
/// The last name of the contact, used to call the contact on the device.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string LastName
{
get { return this._lastName; }
set { this._lastName = value; }
}
// Check to see if LastName property is set
internal bool IsSetLastName()
{
return this._lastName != null;
}
/// <summary>
/// Gets and sets the property PhoneNumber.
/// <para>
/// The phone number of the contact. The phone number type defaults to WORK. You can either
/// specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which
/// lets you specify the phone number type and multiple numbers.
/// </para>
/// </summary>
[AWSProperty(Sensitive=true, Min=0, Max=50)]
public string PhoneNumber
{
get { return this._phoneNumber; }
set { this._phoneNumber = value; }
}
// Check to see if PhoneNumber property is set
internal bool IsSetPhoneNumber()
{
return this._phoneNumber != null;
}
/// <summary>
/// Gets and sets the property PhoneNumbers.
/// <para>
/// The list of phone numbers for the contact.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=3)]
public List<PhoneNumber> PhoneNumbers
{
get { return this._phoneNumbers; }
set { this._phoneNumbers = value; }
}
// Check to see if PhoneNumbers property is set
internal bool IsSetPhoneNumbers()
{
return this._phoneNumbers != null && this._phoneNumbers.Count > 0;
}
/// <summary>
/// Gets and sets the property SipAddresses.
/// <para>
/// The list of SIP addresses for the contact.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=1)]
public List<SipAddress> SipAddresses
{
get { return this._sipAddresses; }
set { this._sipAddresses = value; }
}
// Check to see if SipAddresses property is set
internal bool IsSetSipAddresses()
{
return this._sipAddresses != null && this._sipAddresses.Count > 0;
}
}
} | 179 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Information related to a contact.
/// </summary>
public partial class ContactData
{
private string _contactArn;
private string _displayName;
private string _firstName;
private string _lastName;
private string _phoneNumber;
private List<PhoneNumber> _phoneNumbers = new List<PhoneNumber>();
private List<SipAddress> _sipAddresses = new List<SipAddress>();
/// <summary>
/// Gets and sets the property ContactArn.
/// <para>
/// The ARN of the contact.
/// </para>
/// </summary>
public string ContactArn
{
get { return this._contactArn; }
set { this._contactArn = value; }
}
// Check to see if ContactArn property is set
internal bool IsSetContactArn()
{
return this._contactArn != null;
}
/// <summary>
/// Gets and sets the property DisplayName.
/// <para>
/// The name of the contact to display on the console.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string DisplayName
{
get { return this._displayName; }
set { this._displayName = value; }
}
// Check to see if DisplayName property is set
internal bool IsSetDisplayName()
{
return this._displayName != null;
}
/// <summary>
/// Gets and sets the property FirstName.
/// <para>
/// The first name of the contact, used to call the contact on the device.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string FirstName
{
get { return this._firstName; }
set { this._firstName = value; }
}
// Check to see if FirstName property is set
internal bool IsSetFirstName()
{
return this._firstName != null;
}
/// <summary>
/// Gets and sets the property LastName.
/// <para>
/// The last name of the contact, used to call the contact on the device.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string LastName
{
get { return this._lastName; }
set { this._lastName = value; }
}
// Check to see if LastName property is set
internal bool IsSetLastName()
{
return this._lastName != null;
}
/// <summary>
/// Gets and sets the property PhoneNumber.
/// <para>
/// The phone number of the contact. The phone number type defaults to WORK. You can specify
/// PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you
/// specify the phone number type and multiple numbers.
/// </para>
/// </summary>
[AWSProperty(Sensitive=true, Min=0, Max=50)]
public string PhoneNumber
{
get { return this._phoneNumber; }
set { this._phoneNumber = value; }
}
// Check to see if PhoneNumber property is set
internal bool IsSetPhoneNumber()
{
return this._phoneNumber != null;
}
/// <summary>
/// Gets and sets the property PhoneNumbers.
/// <para>
/// The list of phone numbers for the contact.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=3)]
public List<PhoneNumber> PhoneNumbers
{
get { return this._phoneNumbers; }
set { this._phoneNumbers = value; }
}
// Check to see if PhoneNumbers property is set
internal bool IsSetPhoneNumbers()
{
return this._phoneNumbers != null && this._phoneNumbers.Count > 0;
}
/// <summary>
/// Gets and sets the property SipAddresses.
/// <para>
/// The list of SIP addresses for the contact.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=1)]
public List<SipAddress> SipAddresses
{
get { return this._sipAddresses; }
set { this._sipAddresses = value; }
}
// Check to see if SipAddresses property is set
internal bool IsSetSipAddresses()
{
return this._sipAddresses != null && this._sipAddresses.Count > 0;
}
}
} | 179 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// The content definition. This can contain only one text, SSML, or audio list object.
/// </summary>
public partial class Content
{
private List<Audio> _audioList = new List<Audio>();
private List<Ssml> _ssmlList = new List<Ssml>();
private List<Text> _textList = new List<Text>();
/// <summary>
/// Gets and sets the property AudioList.
/// <para>
/// The list of audio messages.
/// </para>
/// </summary>
[AWSProperty(Max=1)]
public List<Audio> AudioList
{
get { return this._audioList; }
set { this._audioList = value; }
}
// Check to see if AudioList property is set
internal bool IsSetAudioList()
{
return this._audioList != null && this._audioList.Count > 0;
}
/// <summary>
/// Gets and sets the property SsmlList.
/// <para>
/// The list of SSML messages.
/// </para>
/// </summary>
[AWSProperty(Max=1)]
public List<Ssml> SsmlList
{
get { return this._ssmlList; }
set { this._ssmlList = value; }
}
// Check to see if SsmlList property is set
internal bool IsSetSsmlList()
{
return this._ssmlList != null && this._ssmlList.Count > 0;
}
/// <summary>
/// Gets and sets the property TextList.
/// <para>
/// The list of text messages.
/// </para>
/// </summary>
[AWSProperty(Max=1)]
public List<Text> TextList
{
get { return this._textList; }
set { this._textList = value; }
}
// Check to see if TextList property is set
internal bool IsSetTextList()
{
return this._textList != null && this._textList.Count > 0;
}
}
} | 98 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateAddressBook operation.
/// Creates an address book with the specified details.
/// </summary>
public partial class CreateAddressBookRequest : AmazonAlexaForBusinessRequest
{
private string _clientRequestToken;
private string _description;
private string _name;
private List<Tag> _tags = new List<Tag>();
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// <para>
/// A unique, user-specified identifier for the request that ensures idempotency.
/// </para>
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property Description.
/// <para>
/// The description of the address book.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=200)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
/// <summary>
/// Gets and sets the property Name.
/// <para>
/// The name of the address book.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=100)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags to be added to the specified resource. Do not provide system tags.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
}
} | 118 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateAddressBook operation.
/// </summary>
public partial class CreateAddressBookResponse : AmazonWebServiceResponse
{
private string _addressBookArn;
/// <summary>
/// Gets and sets the property AddressBookArn.
/// <para>
/// The ARN of the newly created address book.
/// </para>
/// </summary>
public string AddressBookArn
{
get { return this._addressBookArn; }
set { this._addressBookArn = value; }
}
// Check to see if AddressBookArn property is set
internal bool IsSetAddressBookArn()
{
return this._addressBookArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateBusinessReportSchedule operation.
/// Creates a recurring schedule for usage reports to deliver to the specified S3 location
/// with a specified daily or weekly interval.
/// </summary>
public partial class CreateBusinessReportScheduleRequest : AmazonAlexaForBusinessRequest
{
private string _clientRequestToken;
private BusinessReportContentRange _contentRange;
private BusinessReportFormat _format;
private BusinessReportRecurrence _recurrence;
private string _s3BucketName;
private string _s3KeyPrefix;
private string _scheduleName;
private List<Tag> _tags = new List<Tag>();
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// <para>
/// The client request token.
/// </para>
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property ContentRange.
/// <para>
/// The content range of the reports.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public BusinessReportContentRange ContentRange
{
get { return this._contentRange; }
set { this._contentRange = value; }
}
// Check to see if ContentRange property is set
internal bool IsSetContentRange()
{
return this._contentRange != null;
}
/// <summary>
/// Gets and sets the property Format.
/// <para>
/// The format of the generated report (individual CSV files or zipped files of individual
/// files).
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public BusinessReportFormat Format
{
get { return this._format; }
set { this._format = value; }
}
// Check to see if Format property is set
internal bool IsSetFormat()
{
return this._format != null;
}
/// <summary>
/// Gets and sets the property Recurrence.
/// <para>
/// The recurrence of the reports. If this isn't specified, the report will only be delivered
/// one time when the API is called.
/// </para>
/// </summary>
public BusinessReportRecurrence Recurrence
{
get { return this._recurrence; }
set { this._recurrence = value; }
}
// Check to see if Recurrence property is set
internal bool IsSetRecurrence()
{
return this._recurrence != null;
}
/// <summary>
/// Gets and sets the property S3BucketName.
/// <para>
/// The S3 bucket name of the output reports. If this isn't specified, the report can
/// be retrieved from a download link by calling ListBusinessReportSchedule.
/// </para>
/// </summary>
public string S3BucketName
{
get { return this._s3BucketName; }
set { this._s3BucketName = value; }
}
// Check to see if S3BucketName property is set
internal bool IsSetS3BucketName()
{
return this._s3BucketName != null;
}
/// <summary>
/// Gets and sets the property S3KeyPrefix.
/// <para>
/// The S3 key where the report is delivered.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=100)]
public string S3KeyPrefix
{
get { return this._s3KeyPrefix; }
set { this._s3KeyPrefix = value; }
}
// Check to see if S3KeyPrefix property is set
internal bool IsSetS3KeyPrefix()
{
return this._s3KeyPrefix != null;
}
/// <summary>
/// Gets and sets the property ScheduleName.
/// <para>
/// The name identifier of the schedule.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=64)]
public string ScheduleName
{
get { return this._scheduleName; }
set { this._scheduleName = value; }
}
// Check to see if ScheduleName property is set
internal bool IsSetScheduleName()
{
return this._scheduleName != null;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags for the business report schedule.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
}
} | 200 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateBusinessReportSchedule operation.
/// </summary>
public partial class CreateBusinessReportScheduleResponse : AmazonWebServiceResponse
{
private string _scheduleArn;
/// <summary>
/// Gets and sets the property ScheduleArn.
/// <para>
/// The ARN of the business report schedule.
/// </para>
/// </summary>
public string ScheduleArn
{
get { return this._scheduleArn; }
set { this._scheduleArn = value; }
}
// Check to see if ScheduleArn property is set
internal bool IsSetScheduleArn()
{
return this._scheduleArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateConferenceProvider operation.
/// Adds a new conference provider under the user's AWS account.
/// </summary>
public partial class CreateConferenceProviderRequest : AmazonAlexaForBusinessRequest
{
private string _clientRequestToken;
private string _conferenceProviderName;
private ConferenceProviderType _conferenceProviderType;
private IPDialIn _ipDialIn;
private MeetingSetting _meetingSetting;
private PSTNDialIn _pstnDialIn;
private List<Tag> _tags = new List<Tag>();
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// <para>
/// The request token of the client.
/// </para>
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property ConferenceProviderName.
/// <para>
/// The name of the conference provider.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=50)]
public string ConferenceProviderName
{
get { return this._conferenceProviderName; }
set { this._conferenceProviderName = value; }
}
// Check to see if ConferenceProviderName property is set
internal bool IsSetConferenceProviderName()
{
return this._conferenceProviderName != null;
}
/// <summary>
/// Gets and sets the property ConferenceProviderType.
/// <para>
/// Represents a type within a list of predefined types.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public ConferenceProviderType ConferenceProviderType
{
get { return this._conferenceProviderType; }
set { this._conferenceProviderType = value; }
}
// Check to see if ConferenceProviderType property is set
internal bool IsSetConferenceProviderType()
{
return this._conferenceProviderType != null;
}
/// <summary>
/// Gets and sets the property IPDialIn.
/// <para>
/// The IP endpoint and protocol for calling.
/// </para>
/// </summary>
public IPDialIn IPDialIn
{
get { return this._ipDialIn; }
set { this._ipDialIn = value; }
}
// Check to see if IPDialIn property is set
internal bool IsSetIPDialIn()
{
return this._ipDialIn != null;
}
/// <summary>
/// Gets and sets the property MeetingSetting.
/// <para>
/// The meeting settings for the conference provider.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public MeetingSetting MeetingSetting
{
get { return this._meetingSetting; }
set { this._meetingSetting = value; }
}
// Check to see if MeetingSetting property is set
internal bool IsSetMeetingSetting()
{
return this._meetingSetting != null;
}
/// <summary>
/// Gets and sets the property PSTNDialIn.
/// <para>
/// The information for PSTN conferencing.
/// </para>
/// </summary>
public PSTNDialIn PSTNDialIn
{
get { return this._pstnDialIn; }
set { this._pstnDialIn = value; }
}
// Check to see if PSTNDialIn property is set
internal bool IsSetPSTNDialIn()
{
return this._pstnDialIn != null;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags to be added to the specified resource. Do not provide system tags.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
}
} | 176 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateConferenceProvider operation.
/// </summary>
public partial class CreateConferenceProviderResponse : AmazonWebServiceResponse
{
private string _conferenceProviderArn;
/// <summary>
/// Gets and sets the property ConferenceProviderArn.
/// <para>
/// The ARN of the newly-created conference provider.
/// </para>
/// </summary>
public string ConferenceProviderArn
{
get { return this._conferenceProviderArn; }
set { this._conferenceProviderArn = value; }
}
// Check to see if ConferenceProviderArn property is set
internal bool IsSetConferenceProviderArn()
{
return this._conferenceProviderArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateContact operation.
/// Creates a contact with the specified details.
/// </summary>
public partial class CreateContactRequest : AmazonAlexaForBusinessRequest
{
private string _clientRequestToken;
private string _displayName;
private string _firstName;
private string _lastName;
private string _phoneNumber;
private List<PhoneNumber> _phoneNumbers = new List<PhoneNumber>();
private List<SipAddress> _sipAddresses = new List<SipAddress>();
private List<Tag> _tags = new List<Tag>();
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// <para>
/// A unique, user-specified identifier for this request that ensures idempotency.
/// </para>
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property DisplayName.
/// <para>
/// The name of the contact to display on the console.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string DisplayName
{
get { return this._displayName; }
set { this._displayName = value; }
}
// Check to see if DisplayName property is set
internal bool IsSetDisplayName()
{
return this._displayName != null;
}
/// <summary>
/// Gets and sets the property FirstName.
/// <para>
/// The first name of the contact that is used to call the contact on the device.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=100)]
public string FirstName
{
get { return this._firstName; }
set { this._firstName = value; }
}
// Check to see if FirstName property is set
internal bool IsSetFirstName()
{
return this._firstName != null;
}
/// <summary>
/// Gets and sets the property LastName.
/// <para>
/// The last name of the contact that is used to call the contact on the device.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=100)]
public string LastName
{
get { return this._lastName; }
set { this._lastName = value; }
}
// Check to see if LastName property is set
internal bool IsSetLastName()
{
return this._lastName != null;
}
/// <summary>
/// Gets and sets the property PhoneNumber.
/// <para>
/// The phone number of the contact in E.164 format. The phone number type defaults to
/// WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers,
/// which lets you specify the phone number type and multiple numbers.
/// </para>
/// </summary>
[AWSProperty(Sensitive=true, Min=0, Max=50)]
public string PhoneNumber
{
get { return this._phoneNumber; }
set { this._phoneNumber = value; }
}
// Check to see if PhoneNumber property is set
internal bool IsSetPhoneNumber()
{
return this._phoneNumber != null;
}
/// <summary>
/// Gets and sets the property PhoneNumbers.
/// <para>
/// The list of phone numbers for the contact.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=3)]
public List<PhoneNumber> PhoneNumbers
{
get { return this._phoneNumbers; }
set { this._phoneNumbers = value; }
}
// Check to see if PhoneNumbers property is set
internal bool IsSetPhoneNumbers()
{
return this._phoneNumbers != null && this._phoneNumbers.Count > 0;
}
/// <summary>
/// Gets and sets the property SipAddresses.
/// <para>
/// The list of SIP addresses for the contact.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=1)]
public List<SipAddress> SipAddresses
{
get { return this._sipAddresses; }
set { this._sipAddresses = value; }
}
// Check to see if SipAddresses property is set
internal bool IsSetSipAddresses()
{
return this._sipAddresses != null && this._sipAddresses.Count > 0;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags to be added to the specified resource. Do not provide system tags.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
}
} | 200 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateContact operation.
/// </summary>
public partial class CreateContactResponse : AmazonWebServiceResponse
{
private string _contactArn;
/// <summary>
/// Gets and sets the property ContactArn.
/// <para>
/// The ARN of the newly created address book.
/// </para>
/// </summary>
public string ContactArn
{
get { return this._contactArn; }
set { this._contactArn = value; }
}
// Check to see if ContactArn property is set
internal bool IsSetContactArn()
{
return this._contactArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Creates settings for the end of meeting reminder feature that are applied to a room
/// profile. The end of meeting reminder enables Alexa to remind users when a meeting
/// is ending.
/// </summary>
public partial class CreateEndOfMeetingReminder
{
private bool? _enabled;
private List<int> _reminderAtMinutes = new List<int>();
private EndOfMeetingReminderType _reminderType;
/// <summary>
/// Gets and sets the property Enabled.
/// <para>
/// Whether an end of meeting reminder is enabled or not.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public bool Enabled
{
get { return this._enabled.GetValueOrDefault(); }
set { this._enabled = value; }
}
// Check to see if Enabled property is set
internal bool IsSetEnabled()
{
return this._enabled.HasValue;
}
/// <summary>
/// Gets and sets the property ReminderAtMinutes.
/// <para>
/// A range of 3 to 15 minutes that determines when the reminder begins.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=1)]
public List<int> ReminderAtMinutes
{
get { return this._reminderAtMinutes; }
set { this._reminderAtMinutes = value; }
}
// Check to see if ReminderAtMinutes property is set
internal bool IsSetReminderAtMinutes()
{
return this._reminderAtMinutes != null && this._reminderAtMinutes.Count > 0;
}
/// <summary>
/// Gets and sets the property ReminderType.
/// <para>
/// The type of sound that users hear during the end of meeting reminder.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public EndOfMeetingReminderType ReminderType
{
get { return this._reminderType; }
set { this._reminderType = value; }
}
// Check to see if ReminderType property is set
internal bool IsSetReminderType()
{
return this._reminderType != null;
}
}
} | 100 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateGatewayGroup operation.
/// Creates a gateway group with the specified details.
/// </summary>
public partial class CreateGatewayGroupRequest : AmazonAlexaForBusinessRequest
{
private string _clientRequestToken;
private string _description;
private string _name;
private List<Tag> _tags = new List<Tag>();
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// <para>
/// A unique, user-specified identifier for the request that ensures idempotency.
/// </para>
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property Description.
/// <para>
/// The description of the gateway group.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=200)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
/// <summary>
/// Gets and sets the property Name.
/// <para>
/// The name of the gateway group.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=100)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags to be added to the specified resource. Do not provide system tags.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
}
} | 118 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateGatewayGroup operation.
/// </summary>
public partial class CreateGatewayGroupResponse : AmazonWebServiceResponse
{
private string _gatewayGroupArn;
/// <summary>
/// Gets and sets the property GatewayGroupArn.
/// <para>
/// The ARN of the created gateway group.
/// </para>
/// </summary>
public string GatewayGroupArn
{
get { return this._gatewayGroupArn; }
set { this._gatewayGroupArn = value; }
}
// Check to see if GatewayGroupArn property is set
internal bool IsSetGatewayGroupArn()
{
return this._gatewayGroupArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Creates settings for the instant booking feature that are applied to a room profile.
/// When users start their meeting with Alexa, Alexa automatically books the room for
/// the configured duration if the room is available.
/// </summary>
public partial class CreateInstantBooking
{
private int? _durationInMinutes;
private bool? _enabled;
/// <summary>
/// Gets and sets the property DurationInMinutes.
/// <para>
/// Duration between 15 and 240 minutes at increments of 15 that determines how long to
/// book an available room when a meeting is started with Alexa.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public int DurationInMinutes
{
get { return this._durationInMinutes.GetValueOrDefault(); }
set { this._durationInMinutes = value; }
}
// Check to see if DurationInMinutes property is set
internal bool IsSetDurationInMinutes()
{
return this._durationInMinutes.HasValue;
}
/// <summary>
/// Gets and sets the property Enabled.
/// <para>
/// Whether instant booking is enabled or not.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public bool Enabled
{
get { return this._enabled.GetValueOrDefault(); }
set { this._enabled = value; }
}
// Check to see if Enabled property is set
internal bool IsSetEnabled()
{
return this._enabled.HasValue;
}
}
} | 81 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateNetworkProfile operation.
/// Creates a network profile with the specified details.
/// </summary>
public partial class CreateNetworkProfileRequest : AmazonAlexaForBusinessRequest
{
private string _certificateAuthorityArn;
private string _clientRequestToken;
private string _currentPassword;
private string _description;
private NetworkEapMethod _eapMethod;
private string _networkProfileName;
private string _nextPassword;
private NetworkSecurityType _securityType;
private string _ssid;
private List<Tag> _tags = new List<Tag>();
private List<string> _trustAnchors = new List<string>();
/// <summary>
/// Gets and sets the property CertificateAuthorityArn.
/// <para>
/// The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager
/// (ACM). This is used to issue certificates to the devices.
/// </para>
/// </summary>
public string CertificateAuthorityArn
{
get { return this._certificateAuthorityArn; }
set { this._certificateAuthorityArn = value; }
}
// Check to see if CertificateAuthorityArn property is set
internal bool IsSetCertificateAuthorityArn()
{
return this._certificateAuthorityArn != null;
}
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property CurrentPassword.
/// <para>
/// The current password of the Wi-Fi network.
/// </para>
/// </summary>
[AWSProperty(Sensitive=true, Min=5, Max=128)]
public string CurrentPassword
{
get { return this._currentPassword; }
set { this._currentPassword = value; }
}
// Check to see if CurrentPassword property is set
internal bool IsSetCurrentPassword()
{
return this._currentPassword != null;
}
/// <summary>
/// Gets and sets the property Description.
/// <para>
/// Detailed information about a device's network profile.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=200)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
/// <summary>
/// Gets and sets the property EapMethod.
/// <para>
/// The authentication standard that is used in the EAP framework. Currently, EAP_TLS
/// is supported.
/// </para>
/// </summary>
public NetworkEapMethod EapMethod
{
get { return this._eapMethod; }
set { this._eapMethod = value; }
}
// Check to see if EapMethod property is set
internal bool IsSetEapMethod()
{
return this._eapMethod != null;
}
/// <summary>
/// Gets and sets the property NetworkProfileName.
/// <para>
/// The name of the network profile associated with a device.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=100)]
public string NetworkProfileName
{
get { return this._networkProfileName; }
set { this._networkProfileName = value; }
}
// Check to see if NetworkProfileName property is set
internal bool IsSetNetworkProfileName()
{
return this._networkProfileName != null;
}
/// <summary>
/// Gets and sets the property NextPassword.
/// <para>
/// The next, or subsequent, password of the Wi-Fi network. This password is asynchronously
/// transmitted to the device and is used when the password of the network changes to
/// NextPassword.
/// </para>
/// </summary>
[AWSProperty(Sensitive=true, Min=0, Max=128)]
public string NextPassword
{
get { return this._nextPassword; }
set { this._nextPassword = value; }
}
// Check to see if NextPassword property is set
internal bool IsSetNextPassword()
{
return this._nextPassword != null;
}
/// <summary>
/// Gets and sets the property SecurityType.
/// <para>
/// The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK,
/// WEP, or OPEN.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public NetworkSecurityType SecurityType
{
get { return this._securityType; }
set { this._securityType = value; }
}
// Check to see if SecurityType property is set
internal bool IsSetSecurityType()
{
return this._securityType != null;
}
/// <summary>
/// Gets and sets the property Ssid.
/// <para>
/// The SSID of the Wi-Fi network.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=32)]
public string Ssid
{
get { return this._ssid; }
set { this._ssid = value; }
}
// Check to see if Ssid property is set
internal bool IsSetSsid()
{
return this._ssid != null;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags to be added to the specified resource. Do not provide system tags.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
/// <summary>
/// Gets and sets the property TrustAnchors.
/// <para>
/// The root certificates of your authentication server that is installed on your devices
/// and used to trust your authentication server during EAP negotiation.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=5)]
public List<string> TrustAnchors
{
get { return this._trustAnchors; }
set { this._trustAnchors = value; }
}
// Check to see if TrustAnchors property is set
internal bool IsSetTrustAnchors()
{
return this._trustAnchors != null && this._trustAnchors.Count > 0;
}
}
} | 259 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateNetworkProfile operation.
/// </summary>
public partial class CreateNetworkProfileResponse : AmazonWebServiceResponse
{
private string _networkProfileArn;
/// <summary>
/// Gets and sets the property NetworkProfileArn.
/// <para>
/// The ARN of the network profile associated with a device.
/// </para>
/// </summary>
public string NetworkProfileArn
{
get { return this._networkProfileArn; }
set { this._networkProfileArn = value; }
}
// Check to see if NetworkProfileArn property is set
internal bool IsSetNetworkProfileArn()
{
return this._networkProfileArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
///
/// </summary>
public partial class CreateProactiveJoin
{
private bool? _enabledByMotion;
/// <summary>
/// Gets and sets the property EnabledByMotion.
/// </summary>
[AWSProperty(Required=true)]
public bool EnabledByMotion
{
get { return this._enabledByMotion.GetValueOrDefault(); }
set { this._enabledByMotion = value; }
}
// Check to see if EnabledByMotion property is set
internal bool IsSetEnabledByMotion()
{
return this._enabledByMotion.HasValue;
}
}
} | 55 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateProfile operation.
/// Creates a new room profile with the specified details.
/// </summary>
public partial class CreateProfileRequest : AmazonAlexaForBusinessRequest
{
private string _address;
private string _clientRequestToken;
private bool? _dataRetentionOptIn;
private DistanceUnit _distanceUnit;
private string _locale;
private int? _maxVolumeLimit;
private CreateMeetingRoomConfiguration _meetingRoomConfiguration;
private string _profileName;
private bool? _pstnEnabled;
private bool? _setupModeDisabled;
private List<Tag> _tags = new List<Tag>();
private TemperatureUnit _temperatureUnit;
private string _timezone;
private WakeWord _wakeWord;
/// <summary>
/// Gets and sets the property Address.
/// <para>
/// The valid address for the room.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=500)]
public string Address
{
get { return this._address; }
set { this._address = value; }
}
// Check to see if Address property is set
internal bool IsSetAddress()
{
return this._address != null;
}
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// <para>
/// The user-specified token that is used during the creation of a profile.
/// </para>
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property DataRetentionOptIn.
/// <para>
/// Whether data retention of the profile is enabled.
/// </para>
/// </summary>
public bool DataRetentionOptIn
{
get { return this._dataRetentionOptIn.GetValueOrDefault(); }
set { this._dataRetentionOptIn = value; }
}
// Check to see if DataRetentionOptIn property is set
internal bool IsSetDataRetentionOptIn()
{
return this._dataRetentionOptIn.HasValue;
}
/// <summary>
/// Gets and sets the property DistanceUnit.
/// <para>
/// The distance unit to be used by devices in the profile.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public DistanceUnit DistanceUnit
{
get { return this._distanceUnit; }
set { this._distanceUnit = value; }
}
// Check to see if DistanceUnit property is set
internal bool IsSetDistanceUnit()
{
return this._distanceUnit != null;
}
/// <summary>
/// Gets and sets the property Locale.
/// <para>
/// The locale of the room profile. (This is currently only available to a limited preview
/// audience.)
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=256)]
public string Locale
{
get { return this._locale; }
set { this._locale = value; }
}
// Check to see if Locale property is set
internal bool IsSetLocale()
{
return this._locale != null;
}
/// <summary>
/// Gets and sets the property MaxVolumeLimit.
/// <para>
/// The maximum volume limit for a room profile.
/// </para>
/// </summary>
public int MaxVolumeLimit
{
get { return this._maxVolumeLimit.GetValueOrDefault(); }
set { this._maxVolumeLimit = value; }
}
// Check to see if MaxVolumeLimit property is set
internal bool IsSetMaxVolumeLimit()
{
return this._maxVolumeLimit.HasValue;
}
/// <summary>
/// Gets and sets the property MeetingRoomConfiguration.
/// <para>
/// The meeting room settings of a room profile.
/// </para>
/// </summary>
public CreateMeetingRoomConfiguration MeetingRoomConfiguration
{
get { return this._meetingRoomConfiguration; }
set { this._meetingRoomConfiguration = value; }
}
// Check to see if MeetingRoomConfiguration property is set
internal bool IsSetMeetingRoomConfiguration()
{
return this._meetingRoomConfiguration != null;
}
/// <summary>
/// Gets and sets the property ProfileName.
/// <para>
/// The name of a room profile.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=100)]
public string ProfileName
{
get { return this._profileName; }
set { this._profileName = value; }
}
// Check to see if ProfileName property is set
internal bool IsSetProfileName()
{
return this._profileName != null;
}
/// <summary>
/// Gets and sets the property PSTNEnabled.
/// <para>
/// Whether PSTN calling is enabled.
/// </para>
/// </summary>
public bool PSTNEnabled
{
get { return this._pstnEnabled.GetValueOrDefault(); }
set { this._pstnEnabled = value; }
}
// Check to see if PSTNEnabled property is set
internal bool IsSetPSTNEnabled()
{
return this._pstnEnabled.HasValue;
}
/// <summary>
/// Gets and sets the property SetupModeDisabled.
/// <para>
/// Whether room profile setup is enabled.
/// </para>
/// </summary>
public bool SetupModeDisabled
{
get { return this._setupModeDisabled.GetValueOrDefault(); }
set { this._setupModeDisabled = value; }
}
// Check to see if SetupModeDisabled property is set
internal bool IsSetSetupModeDisabled()
{
return this._setupModeDisabled.HasValue;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags for the profile.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
/// <summary>
/// Gets and sets the property TemperatureUnit.
/// <para>
/// The temperature unit to be used by devices in the profile.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public TemperatureUnit TemperatureUnit
{
get { return this._temperatureUnit; }
set { this._temperatureUnit = value; }
}
// Check to see if TemperatureUnit property is set
internal bool IsSetTemperatureUnit()
{
return this._temperatureUnit != null;
}
/// <summary>
/// Gets and sets the property Timezone.
/// <para>
/// The time zone used by a room profile.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=100)]
public string Timezone
{
get { return this._timezone; }
set { this._timezone = value; }
}
// Check to see if Timezone property is set
internal bool IsSetTimezone()
{
return this._timezone != null;
}
/// <summary>
/// Gets and sets the property WakeWord.
/// <para>
/// A wake word for Alexa, Echo, Amazon, or a computer.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public WakeWord WakeWord
{
get { return this._wakeWord; }
set { this._wakeWord = value; }
}
// Check to see if WakeWord property is set
internal bool IsSetWakeWord()
{
return this._wakeWord != null;
}
}
} | 314 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateProfile operation.
/// </summary>
public partial class CreateProfileResponse : AmazonWebServiceResponse
{
private string _profileArn;
/// <summary>
/// Gets and sets the property ProfileArn.
/// <para>
/// The ARN of the newly created room profile in the response.
/// </para>
/// </summary>
public string ProfileArn
{
get { return this._profileArn; }
set { this._profileArn = value; }
}
// Check to see if ProfileArn property is set
internal bool IsSetProfileArn()
{
return this._profileArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Creates settings for the require check in feature that are applied to a room profile.
/// Require check in allows a meeting room’s Alexa or AVS device to prompt the user to
/// check in; otherwise, the room will be released.
/// </summary>
public partial class CreateRequireCheckIn
{
private bool? _enabled;
private int? _releaseAfterMinutes;
/// <summary>
/// Gets and sets the property Enabled.
/// <para>
/// Whether require check in is enabled or not.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public bool Enabled
{
get { return this._enabled.GetValueOrDefault(); }
set { this._enabled = value; }
}
// Check to see if Enabled property is set
internal bool IsSetEnabled()
{
return this._enabled.HasValue;
}
/// <summary>
/// Gets and sets the property ReleaseAfterMinutes.
/// <para>
/// Duration between 5 and 20 minutes to determine when to release the room if it's not
/// checked into.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public int ReleaseAfterMinutes
{
get { return this._releaseAfterMinutes.GetValueOrDefault(); }
set { this._releaseAfterMinutes = value; }
}
// Check to see if ReleaseAfterMinutes property is set
internal bool IsSetReleaseAfterMinutes()
{
return this._releaseAfterMinutes.HasValue;
}
}
} | 81 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateRoom operation.
/// Creates a room with the specified details.
/// </summary>
public partial class CreateRoomRequest : AmazonAlexaForBusinessRequest
{
private string _clientRequestToken;
private string _description;
private string _profileArn;
private string _providerCalendarId;
private string _roomName;
private List<Tag> _tags = new List<Tag>();
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// <para>
/// A unique, user-specified identifier for this request that ensures idempotency.
/// </para>
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property Description.
/// <para>
/// The description for the room.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=200)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
/// <summary>
/// Gets and sets the property ProfileArn.
/// <para>
/// The profile ARN for the room. This is required.
/// </para>
/// </summary>
public string ProfileArn
{
get { return this._profileArn; }
set { this._profileArn = value; }
}
// Check to see if ProfileArn property is set
internal bool IsSetProfileArn()
{
return this._profileArn != null;
}
/// <summary>
/// Gets and sets the property ProviderCalendarId.
/// <para>
/// The calendar ARN for the room.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=100)]
public string ProviderCalendarId
{
get { return this._providerCalendarId; }
set { this._providerCalendarId = value; }
}
// Check to see if ProviderCalendarId property is set
internal bool IsSetProviderCalendarId()
{
return this._providerCalendarId != null;
}
/// <summary>
/// Gets and sets the property RoomName.
/// <para>
/// The name for the room.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=100)]
public string RoomName
{
get { return this._roomName; }
set { this._roomName = value; }
}
// Check to see if RoomName property is set
internal bool IsSetRoomName()
{
return this._roomName != null;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags for the room.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
}
} | 157 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateRoom operation.
/// </summary>
public partial class CreateRoomResponse : AmazonWebServiceResponse
{
private string _roomArn;
/// <summary>
/// Gets and sets the property RoomArn.
/// <para>
/// The ARN of the newly created room in the response.
/// </para>
/// </summary>
public string RoomArn
{
get { return this._roomArn; }
set { this._roomArn = value; }
}
// Check to see if RoomArn property is set
internal bool IsSetRoomArn()
{
return this._roomArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateSkillGroup operation.
/// Creates a skill group with a specified name and description.
/// </summary>
public partial class CreateSkillGroupRequest : AmazonAlexaForBusinessRequest
{
private string _clientRequestToken;
private string _description;
private string _skillGroupName;
private List<Tag> _tags = new List<Tag>();
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// <para>
/// A unique, user-specified identifier for this request that ensures idempotency.
/// </para>
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property Description.
/// <para>
/// The description for the skill group.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=200)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
/// <summary>
/// Gets and sets the property SkillGroupName.
/// <para>
/// The name for the skill group.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=100)]
public string SkillGroupName
{
get { return this._skillGroupName; }
set { this._skillGroupName = value; }
}
// Check to see if SkillGroupName property is set
internal bool IsSetSkillGroupName()
{
return this._skillGroupName != null;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags for the skill group.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
}
} | 118 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateSkillGroup operation.
/// </summary>
public partial class CreateSkillGroupResponse : AmazonWebServiceResponse
{
private string _skillGroupArn;
/// <summary>
/// Gets and sets the property SkillGroupArn.
/// <para>
/// The ARN of the newly created skill group in the response.
/// </para>
/// </summary>
public string SkillGroupArn
{
get { return this._skillGroupArn; }
set { this._skillGroupArn = value; }
}
// Check to see if SkillGroupArn property is set
internal bool IsSetSkillGroupArn()
{
return this._skillGroupArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the CreateUser operation.
/// Creates a user.
/// </summary>
public partial class CreateUserRequest : AmazonAlexaForBusinessRequest
{
private string _clientRequestToken;
private string _email;
private string _firstName;
private string _lastName;
private List<Tag> _tags = new List<Tag>();
private string _userId;
/// <summary>
/// Gets and sets the property ClientRequestToken.
/// <para>
/// A unique, user-specified identifier for this request that ensures idempotency.
/// </para>
/// </summary>
[AWSProperty(Min=10, Max=150)]
public string ClientRequestToken
{
get { return this._clientRequestToken; }
set { this._clientRequestToken = value; }
}
// Check to see if ClientRequestToken property is set
internal bool IsSetClientRequestToken()
{
return this._clientRequestToken != null;
}
/// <summary>
/// Gets and sets the property Email.
/// <para>
/// The email address for the user.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=128)]
public string Email
{
get { return this._email; }
set { this._email = value; }
}
// Check to see if Email property is set
internal bool IsSetEmail()
{
return this._email != null;
}
/// <summary>
/// Gets and sets the property FirstName.
/// <para>
/// The first name for the user.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=30)]
public string FirstName
{
get { return this._firstName; }
set { this._firstName = value; }
}
// Check to see if FirstName property is set
internal bool IsSetFirstName()
{
return this._firstName != null;
}
/// <summary>
/// Gets and sets the property LastName.
/// <para>
/// The last name for the user.
/// </para>
/// </summary>
[AWSProperty(Min=0, Max=30)]
public string LastName
{
get { return this._lastName; }
set { this._lastName = value; }
}
// Check to see if LastName property is set
internal bool IsSetLastName()
{
return this._lastName != null;
}
/// <summary>
/// Gets and sets the property Tags.
/// <para>
/// The tags for the user.
/// </para>
/// </summary>
public List<Tag> Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
/// <summary>
/// Gets and sets the property UserId.
/// <para>
/// The ARN for the user.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=128)]
public string UserId
{
get { return this._userId; }
set { this._userId = value; }
}
// Check to see if UserId property is set
internal bool IsSetUserId()
{
return this._userId != null;
}
}
} | 158 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the CreateUser operation.
/// </summary>
public partial class CreateUserResponse : AmazonWebServiceResponse
{
private string _userArn;
/// <summary>
/// Gets and sets the property UserArn.
/// <para>
/// The ARN of the newly created user in the response.
/// </para>
/// </summary>
public string UserArn
{
get { return this._userArn; }
set { this._userArn = value; }
}
// Check to see if UserArn property is set
internal bool IsSetUserArn()
{
return this._userArn != null;
}
}
} | 57 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteAddressBook operation.
/// Deletes an address book by the address book ARN.
/// </summary>
public partial class DeleteAddressBookRequest : AmazonAlexaForBusinessRequest
{
private string _addressBookArn;
/// <summary>
/// Gets and sets the property AddressBookArn.
/// <para>
/// The ARN of the address book to delete.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string AddressBookArn
{
get { return this._addressBookArn; }
set { this._addressBookArn = value; }
}
// Check to see if AddressBookArn property is set
internal bool IsSetAddressBookArn()
{
return this._addressBookArn != null;
}
}
} | 59 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteAddressBook operation.
/// </summary>
public partial class DeleteAddressBookResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteBusinessReportSchedule operation.
/// Deletes the recurring report delivery schedule with the specified schedule ARN.
/// </summary>
public partial class DeleteBusinessReportScheduleRequest : AmazonAlexaForBusinessRequest
{
private string _scheduleArn;
/// <summary>
/// Gets and sets the property ScheduleArn.
/// <para>
/// The ARN of the business report schedule.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string ScheduleArn
{
get { return this._scheduleArn; }
set { this._scheduleArn = value; }
}
// Check to see if ScheduleArn property is set
internal bool IsSetScheduleArn()
{
return this._scheduleArn != null;
}
}
} | 59 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteBusinessReportSchedule operation.
/// </summary>
public partial class DeleteBusinessReportScheduleResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteConferenceProvider operation.
/// Deletes a conference provider.
/// </summary>
public partial class DeleteConferenceProviderRequest : AmazonAlexaForBusinessRequest
{
private string _conferenceProviderArn;
/// <summary>
/// Gets and sets the property ConferenceProviderArn.
/// <para>
/// The ARN of the conference provider.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string ConferenceProviderArn
{
get { return this._conferenceProviderArn; }
set { this._conferenceProviderArn = value; }
}
// Check to see if ConferenceProviderArn property is set
internal bool IsSetConferenceProviderArn()
{
return this._conferenceProviderArn != null;
}
}
} | 59 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteConferenceProvider operation.
/// </summary>
public partial class DeleteConferenceProviderResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteContact operation.
/// Deletes a contact by the contact ARN.
/// </summary>
public partial class DeleteContactRequest : AmazonAlexaForBusinessRequest
{
private string _contactArn;
/// <summary>
/// Gets and sets the property ContactArn.
/// <para>
/// The ARN of the contact to delete.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string ContactArn
{
get { return this._contactArn; }
set { this._contactArn = value; }
}
// Check to see if ContactArn property is set
internal bool IsSetContactArn()
{
return this._contactArn != null;
}
}
} | 59 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteContact operation.
/// </summary>
public partial class DeleteContactResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteDevice operation.
/// Removes a device from Alexa For Business.
/// </summary>
public partial class DeleteDeviceRequest : AmazonAlexaForBusinessRequest
{
private string _deviceArn;
/// <summary>
/// Gets and sets the property DeviceArn.
/// <para>
/// The ARN of the device for which to request details.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string DeviceArn
{
get { return this._deviceArn; }
set { this._deviceArn = value; }
}
// Check to see if DeviceArn property is set
internal bool IsSetDeviceArn()
{
return this._deviceArn != null;
}
}
} | 59 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteDevice operation.
/// </summary>
public partial class DeleteDeviceResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteDeviceUsageData operation.
/// When this action is called for a specified shared device, it allows authorized users
/// to delete the device's entire previous history of voice input data and associated
/// response data. This action can be called once every 24 hours for a specific shared
/// device.
/// </summary>
public partial class DeleteDeviceUsageDataRequest : AmazonAlexaForBusinessRequest
{
private string _deviceArn;
private DeviceUsageType _deviceUsageType;
/// <summary>
/// Gets and sets the property DeviceArn.
/// <para>
/// The ARN of the device.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string DeviceArn
{
get { return this._deviceArn; }
set { this._deviceArn = value; }
}
// Check to see if DeviceArn property is set
internal bool IsSetDeviceArn()
{
return this._deviceArn != null;
}
/// <summary>
/// Gets and sets the property DeviceUsageType.
/// <para>
/// The type of usage data to delete.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public DeviceUsageType DeviceUsageType
{
get { return this._deviceUsageType; }
set { this._deviceUsageType = value; }
}
// Check to see if DeviceUsageType property is set
internal bool IsSetDeviceUsageType()
{
return this._deviceUsageType != null;
}
}
} | 82 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteDeviceUsageData operation.
/// </summary>
public partial class DeleteDeviceUsageDataResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteGatewayGroup operation.
/// Deletes a gateway group.
/// </summary>
public partial class DeleteGatewayGroupRequest : AmazonAlexaForBusinessRequest
{
private string _gatewayGroupArn;
/// <summary>
/// Gets and sets the property GatewayGroupArn.
/// <para>
/// The ARN of the gateway group to delete.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string GatewayGroupArn
{
get { return this._gatewayGroupArn; }
set { this._gatewayGroupArn = value; }
}
// Check to see if GatewayGroupArn property is set
internal bool IsSetGatewayGroupArn()
{
return this._gatewayGroupArn != null;
}
}
} | 59 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteGatewayGroup operation.
/// </summary>
public partial class DeleteGatewayGroupResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteNetworkProfile operation.
/// Deletes a network profile by the network profile ARN.
/// </summary>
public partial class DeleteNetworkProfileRequest : AmazonAlexaForBusinessRequest
{
private string _networkProfileArn;
/// <summary>
/// Gets and sets the property NetworkProfileArn.
/// <para>
/// The ARN of the network profile associated with a device.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string NetworkProfileArn
{
get { return this._networkProfileArn; }
set { this._networkProfileArn = value; }
}
// Check to see if NetworkProfileArn property is set
internal bool IsSetNetworkProfileArn()
{
return this._networkProfileArn != null;
}
}
} | 59 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteNetworkProfile operation.
/// </summary>
public partial class DeleteNetworkProfileResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteProfile operation.
/// Deletes a room profile by the profile ARN.
/// </summary>
public partial class DeleteProfileRequest : AmazonAlexaForBusinessRequest
{
private string _profileArn;
/// <summary>
/// Gets and sets the property ProfileArn.
/// <para>
/// The ARN of the room profile to delete. Required.
/// </para>
/// </summary>
public string ProfileArn
{
get { return this._profileArn; }
set { this._profileArn = value; }
}
// Check to see if ProfileArn property is set
internal bool IsSetProfileArn()
{
return this._profileArn != null;
}
}
} | 58 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteProfile operation.
/// </summary>
public partial class DeleteProfileResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteRoom operation.
/// Deletes a room by the room ARN.
/// </summary>
public partial class DeleteRoomRequest : AmazonAlexaForBusinessRequest
{
private string _roomArn;
/// <summary>
/// Gets and sets the property RoomArn.
/// <para>
/// The ARN of the room to delete. Required.
/// </para>
/// </summary>
public string RoomArn
{
get { return this._roomArn; }
set { this._roomArn = value; }
}
// Check to see if RoomArn property is set
internal bool IsSetRoomArn()
{
return this._roomArn != null;
}
}
} | 58 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteRoom operation.
/// </summary>
public partial class DeleteRoomResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteRoomSkillParameter operation.
/// Deletes room skill parameter details by room, skill, and parameter key ID.
/// </summary>
public partial class DeleteRoomSkillParameterRequest : AmazonAlexaForBusinessRequest
{
private string _parameterKey;
private string _roomArn;
private string _skillId;
/// <summary>
/// Gets and sets the property ParameterKey.
/// <para>
/// The room skill parameter key for which to remove details.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=1, Max=256)]
public string ParameterKey
{
get { return this._parameterKey; }
set { this._parameterKey = value; }
}
// Check to see if ParameterKey property is set
internal bool IsSetParameterKey()
{
return this._parameterKey != null;
}
/// <summary>
/// Gets and sets the property RoomArn.
/// <para>
/// The ARN of the room from which to remove the room skill parameter details.
/// </para>
/// </summary>
public string RoomArn
{
get { return this._roomArn; }
set { this._roomArn = value; }
}
// Check to see if RoomArn property is set
internal bool IsSetRoomArn()
{
return this._roomArn != null;
}
/// <summary>
/// Gets and sets the property SkillId.
/// <para>
/// The ID of the skill from which to remove the room skill parameter details.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string SkillId
{
get { return this._skillId; }
set { this._skillId = value; }
}
// Check to see if SkillId property is set
internal bool IsSetSkillId()
{
return this._skillId != null;
}
}
} | 98 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteRoomSkillParameter operation.
/// </summary>
public partial class DeleteRoomSkillParameterResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteSkillAuthorization operation.
/// Unlinks a third-party account from a skill.
/// </summary>
public partial class DeleteSkillAuthorizationRequest : AmazonAlexaForBusinessRequest
{
private string _roomArn;
private string _skillId;
/// <summary>
/// Gets and sets the property RoomArn.
/// <para>
/// The room that the skill is authorized for.
/// </para>
/// </summary>
public string RoomArn
{
get { return this._roomArn; }
set { this._roomArn = value; }
}
// Check to see if RoomArn property is set
internal bool IsSetRoomArn()
{
return this._roomArn != null;
}
/// <summary>
/// Gets and sets the property SkillId.
/// <para>
/// The unique identifier of a skill.
/// </para>
/// </summary>
[AWSProperty(Required=true)]
public string SkillId
{
get { return this._skillId; }
set { this._skillId = value; }
}
// Check to see if SkillId property is set
internal bool IsSetSkillId()
{
return this._skillId != null;
}
}
} | 78 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteSkillAuthorization operation.
/// </summary>
public partial class DeleteSkillAuthorizationResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteSkillGroup operation.
/// Deletes a skill group by skill group ARN.
/// </summary>
public partial class DeleteSkillGroupRequest : AmazonAlexaForBusinessRequest
{
private string _skillGroupArn;
/// <summary>
/// Gets and sets the property SkillGroupArn.
/// <para>
/// The ARN of the skill group to delete. Required.
/// </para>
/// </summary>
public string SkillGroupArn
{
get { return this._skillGroupArn; }
set { this._skillGroupArn = value; }
}
// Check to see if SkillGroupArn property is set
internal bool IsSetSkillGroupArn()
{
return this._skillGroupArn != null;
}
}
} | 58 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// This is the response object from the DeleteSkillGroup operation.
/// </summary>
public partial class DeleteSkillGroupResponse : AmazonWebServiceResponse
{
}
} | 38 |
aws-sdk-net | aws | C# | /*
* 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 alexaforbusiness-2017-11-09.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.AlexaForBusiness.Model
{
/// <summary>
/// Container for the parameters to the DeleteUser operation.
/// Deletes a specified user by user ARN and enrollment ARN.
/// </summary>
public partial class DeleteUserRequest : AmazonAlexaForBusinessRequest
{
private string _enrollmentId;
private string _userArn;
/// <summary>
/// Gets and sets the property EnrollmentId.
/// <para>
/// The ARN of the user's enrollment in the organization. Required.
/// </para>
/// </summary>
[AWSProperty(Required=true, Min=0, Max=128)]
public string EnrollmentId
{
get { return this._enrollmentId; }
set { this._enrollmentId = value; }
}
// Check to see if EnrollmentId property is set
internal bool IsSetEnrollmentId()
{
return this._enrollmentId != null;
}
/// <summary>
/// Gets and sets the property UserArn.
/// <para>
/// The ARN of the user to delete in the organization. Required.
/// </para>
/// </summary>
public string UserArn
{
get { return this._userArn; }
set { this._userArn = value; }
}
// Check to see if UserArn property is set
internal bool IsSetUserArn()
{
return this._userArn != null;
}
}
} | 78 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.