package types

import "github.com/aws/aws-sdk-go-v2/service/acm/types"

Index

Examples

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have access required to perform this action.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AcmCertificateMetadata

type AcmCertificateMetadata struct {

	// The time at which the certificate was requested.
	CreatedAt *time.Time

	// Indicates whether the certificate can be exported.
	ExportOption CertificateExport

	// Indicates whether the certificate has been exported.
	Exported *bool

	// The date and time when the certificate was imported. This value exists only
	// when the certificate type is IMPORTED .
	ImportedAt *time.Time

	// Indicates whether the certificate is currently in use by an Amazon Web Services
	// service.
	InUse *bool

	// The time at which the certificate was issued. This value exists only when the
	// certificate type is AMAZON_ISSUED .
	IssuedAt *time.Time

	// Identifies the Amazon Web Services service that manages the certificate issued
	// by ACM.
	ManagedBy CertificateManagedBy

	// Specifies whether the certificate is eligible for renewal. At this time, only
	// exported private certificates can be renewed with the RenewCertificatecommand.
	RenewalEligibility RenewalEligibility

	// The renewal status of the certificate.
	RenewalStatus RenewalStatus

	// The time at which the certificate was revoked. This value exists only when the
	// certificate status is REVOKED .
	RevokedAt *time.Time

	// The status of the certificate.
	//
	// A certificate enters status PENDING_VALIDATION upon being requested, unless it
	// fails for any of the reasons given in the troubleshooting topic [Certificate request fails]. ACM makes
	// repeated attempts to validate a certificate for 72 hours and then times out. If
	// a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request,
	// correct the issue with [DNS validation]or [Email validation], and try again. If validation succeeds, the
	// certificate enters status ISSUED.
	//
	// [DNS validation]: https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html
	// [Certificate request fails]: https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html
	// [Email validation]: https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html
	Status CertificateStatus

	// The source of the certificate. For certificates provided by ACM, this value is
	// AMAZON_ISSUED . For certificates that you imported with ImportCertificate, this value is IMPORTED
	// . ACM does not provide [managed renewal]for imported certificates. For more information about
	// the differences between certificates that you import and those that ACM
	// provides, see [Importing Certificates]in the Certificate Manager User Guide.
	//
	// [Importing Certificates]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
	// [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html
	Type CertificateType

	// Specifies the domain validation method.
	ValidationMethod ValidationMethod
	// contains filtered or unexported fields
}

Contains ACM-specific metadata about a certificate.

type AcmCertificateMetadataFilter

type AcmCertificateMetadataFilter interface {
	// contains filtered or unexported methods
}

Filters certificates by ACM metadata.

The following types satisfy this interface:

AcmCertificateMetadataFilterMemberExported
AcmCertificateMetadataFilterMemberExportOption
AcmCertificateMetadataFilterMemberInUse
AcmCertificateMetadataFilterMemberManagedBy
AcmCertificateMetadataFilterMemberRenewalStatus
AcmCertificateMetadataFilterMemberStatus
AcmCertificateMetadataFilterMemberType
AcmCertificateMetadataFilterMemberValidationMethod
Example (OutputUsage)

Code:play 

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/acm/types"
)

func main() {
	var union types.AcmCertificateMetadataFilter
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AcmCertificateMetadataFilterMemberExported:
		_ = v.Value // Value is bool

	case *types.AcmCertificateMetadataFilterMemberExportOption:
		_ = v.Value // Value is types.CertificateExport

	case *types.AcmCertificateMetadataFilterMemberInUse:
		_ = v.Value // Value is bool

	case *types.AcmCertificateMetadataFilterMemberManagedBy:
		_ = v.Value // Value is types.CertificateManagedBy

	case *types.AcmCertificateMetadataFilterMemberRenewalStatus:
		_ = v.Value // Value is types.RenewalStatus

	case *types.AcmCertificateMetadataFilterMemberStatus:
		_ = v.Value // Value is types.CertificateStatus

	case *types.AcmCertificateMetadataFilterMemberType:
		_ = v.Value // Value is types.CertificateType

	case *types.AcmCertificateMetadataFilterMemberValidationMethod:
		_ = v.Value // Value is types.ValidationMethod

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type AcmCertificateMetadataFilterMemberExportOption

type AcmCertificateMetadataFilterMemberExportOption struct {
	Value CertificateExport
	// contains filtered or unexported fields
}

Filter by certificate export option.

type AcmCertificateMetadataFilterMemberExported

type AcmCertificateMetadataFilterMemberExported struct {
	Value bool
	// contains filtered or unexported fields
}

Filter by whether the certificate has been exported.

type AcmCertificateMetadataFilterMemberInUse

type AcmCertificateMetadataFilterMemberInUse struct {
	Value bool
	// contains filtered or unexported fields
}

Filter by whether the certificate is in use.

type AcmCertificateMetadataFilterMemberManagedBy

type AcmCertificateMetadataFilterMemberManagedBy struct {
	Value CertificateManagedBy
	// contains filtered or unexported fields
}

Filter by the entity that manages the certificate.

type AcmCertificateMetadataFilterMemberRenewalStatus

type AcmCertificateMetadataFilterMemberRenewalStatus struct {
	Value RenewalStatus
	// contains filtered or unexported fields
}

Filter by certificate renewal status.

type AcmCertificateMetadataFilterMemberStatus

type AcmCertificateMetadataFilterMemberStatus struct {
	Value CertificateStatus
	// contains filtered or unexported fields
}

Filter by certificate status.

type AcmCertificateMetadataFilterMemberType

type AcmCertificateMetadataFilterMemberType struct {
	Value CertificateType
	// contains filtered or unexported fields
}

Filter by certificate type.

type AcmCertificateMetadataFilterMemberValidationMethod

type AcmCertificateMetadataFilterMemberValidationMethod struct {
	Value ValidationMethod
	// contains filtered or unexported fields
}

Filter by validation method.

type CertificateDetail

type CertificateDetail struct {

	// The Amazon Resource Name (ARN) of the certificate. For more information about
	// ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	CertificateArn *string

	// The Amazon Resource Name (ARN) of the private certificate authority (CA) that
	// issued the certificate. This has the following format:
	//
	//     arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	CertificateAuthorityArn *string

	// The time at which the certificate was requested.
	CreatedAt *time.Time

	// The fully qualified domain name for the certificate, such as www.example.com or
	// example.com.
	DomainName *string

	// Contains information about the initial validation of each domain name that
	// occurs as a result of the RequestCertificaterequest. This field exists only when the certificate
	// type is AMAZON_ISSUED .
	DomainValidationOptions []DomainValidation

	// Contains a list of Extended Key Usage X.509 v3 extension objects. Each object
	// specifies a purpose for which the certificate public key can be used and
	// consists of a name and an object identifier (OID).
	ExtendedKeyUsages []ExtendedKeyUsage

	// The reason the certificate request failed. This value exists only when the
	// certificate status is FAILED . For more information, see [Certificate Request Failed] in the Certificate
	// Manager User Guide.
	//
	// [Certificate Request Failed]: https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed
	FailureReason FailureReason

	// The date and time when the certificate was imported. This value exists only
	// when the certificate type is IMPORTED .
	ImportedAt *time.Time

	// A list of ARNs for the Amazon Web Services resources that are using the
	// certificate. A certificate can be used by multiple Amazon Web Services
	// resources.
	InUseBy []string

	// The time at which the certificate was issued. This value exists only when the
	// certificate type is AMAZON_ISSUED .
	IssuedAt *time.Time

	// The name of the certificate authority that issued and signed the certificate.
	Issuer *string

	// The algorithm that was used to generate the public-private key pair.
	KeyAlgorithm KeyAlgorithm

	// A list of Key Usage X.509 v3 extension objects. Each object is a string value
	// that identifies the purpose of the public key contained in the certificate.
	// Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT,
	// NON_REPUDIATION, and more.
	KeyUsages []KeyUsage

	// Identifies the Amazon Web Services service that manages the certificate issued
	// by ACM.
	ManagedBy CertificateManagedBy

	// The time after which the certificate is not valid.
	NotAfter *time.Time

	// The time before which the certificate is not valid.
	NotBefore *time.Time

	// Value that specifies whether to add the certificate to a transparency log.
	// Certificate transparency makes it possible to detect SSL certificates that have
	// been mistakenly or maliciously issued. A browser might respond to certificate
	// that has not been logged by showing an error message. The logs are
	// cryptographically secure.
	Options *CertificateOptions

	// Specifies whether the certificate is eligible for renewal. At this time, only
	// exported private certificates can be renewed with the RenewCertificatecommand.
	RenewalEligibility RenewalEligibility

	// Contains information about the status of ACM's [managed renewal] for the certificate. This field
	// exists only when the certificate type is AMAZON_ISSUED .
	//
	// [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html
	RenewalSummary *RenewalSummary

	// The reason the certificate was revoked. This value exists only when the
	// certificate status is REVOKED .
	RevocationReason RevocationReason

	// The time at which the certificate was revoked. This value exists only when the
	// certificate status is REVOKED .
	RevokedAt *time.Time

	// The serial number of the certificate.
	Serial *string

	// The algorithm that was used to sign the certificate.
	SignatureAlgorithm *string

	// The status of the certificate.
	//
	// A certificate enters status PENDING_VALIDATION upon being requested, unless it
	// fails for any of the reasons given in the troubleshooting topic [Certificate request fails]. ACM makes
	// repeated attempts to validate a certificate for 72 hours and then times out. If
	// a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request,
	// correct the issue with [DNS validation]or [Email validation], and try again. If validation succeeds, the
	// certificate enters status ISSUED.
	//
	// [DNS validation]: https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html
	// [Certificate request fails]: https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html
	// [Email validation]: https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html
	Status CertificateStatus

	// The name of the entity that is associated with the public key contained in the
	// certificate.
	Subject *string

	// One or more domain names (subject alternative names) included in the
	// certificate. This list contains the domain names that are bound to the public
	// key that is contained in the certificate. The subject alternative names include
	// the canonical domain name (CN) of the certificate and additional domain names
	// that can be used to connect to the website.
	SubjectAlternativeNames []string

	// The source of the certificate. For certificates provided by ACM, this value is
	// AMAZON_ISSUED . For certificates that you imported with ImportCertificate, this value is IMPORTED
	// . ACM does not provide [managed renewal]for imported certificates. For more information about
	// the differences between certificates that you import and those that ACM
	// provides, see [Importing Certificates]in the Certificate Manager User Guide.
	//
	// [Importing Certificates]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
	// [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html
	Type CertificateType
	// contains filtered or unexported fields
}

Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificaterequest.

type CertificateExport

type CertificateExport string
const (
	CertificateExportEnabled  CertificateExport = "ENABLED"
	CertificateExportDisabled CertificateExport = "DISABLED"
)

Enum values for CertificateExport

func (CertificateExport) Values

Values returns all known values for CertificateExport. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CertificateFilter

type CertificateFilter interface {
	// contains filtered or unexported methods
}

Defines a filter for searching certificates by ARN, X.509 attributes, or ACM metadata.

The following types satisfy this interface:

CertificateFilterMemberAcmCertificateMetadataFilter
CertificateFilterMemberCertificateArn
CertificateFilterMemberX509AttributeFilter
Example (OutputUsage)

Code:play 

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/acm/types"
)

func main() {
	var union types.CertificateFilter
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.CertificateFilterMemberAcmCertificateMetadataFilter:
		_ = v.Value // Value is types.AcmCertificateMetadataFilter

	case *types.CertificateFilterMemberCertificateArn:
		_ = v.Value // Value is string

	case *types.CertificateFilterMemberX509AttributeFilter:
		_ = v.Value // Value is types.X509AttributeFilter

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type CertificateFilterMemberAcmCertificateMetadataFilter

type CertificateFilterMemberAcmCertificateMetadataFilter struct {
	Value AcmCertificateMetadataFilter
	// contains filtered or unexported fields
}

Filter by ACM certificate metadata.

type CertificateFilterMemberCertificateArn

type CertificateFilterMemberCertificateArn struct {
	Value string
	// contains filtered or unexported fields
}

Filter by certificate ARN.

type CertificateFilterMemberX509AttributeFilter

type CertificateFilterMemberX509AttributeFilter struct {
	Value X509AttributeFilter
	// contains filtered or unexported fields
}

Filter by X.509 certificate attributes.

type CertificateFilterStatement

type CertificateFilterStatement interface {
	// contains filtered or unexported methods
}

A filter statement used to search for certificates. Can contain AND, OR, NOT logical operators or a single filter.

The following types satisfy this interface:

CertificateFilterStatementMemberAnd
CertificateFilterStatementMemberFilter
CertificateFilterStatementMemberNot
CertificateFilterStatementMemberOr
Example (OutputUsage)

Code:play 

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/acm/types"
)

func main() {
	var union types.CertificateFilterStatement
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.CertificateFilterStatementMemberAnd:
		_ = v.Value // Value is []types.CertificateFilterStatement

	case *types.CertificateFilterStatementMemberFilter:
		_ = v.Value // Value is types.CertificateFilter

	case *types.CertificateFilterStatementMemberNot:
		_ = v.Value // Value is types.CertificateFilterStatement

	case *types.CertificateFilterStatementMemberOr:
		_ = v.Value // Value is []types.CertificateFilterStatement

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type CertificateFilterStatementMemberAnd

type CertificateFilterStatementMemberAnd struct {
	Value []CertificateFilterStatement
	// contains filtered or unexported fields
}

A list of filter statements that must all be true.

type CertificateFilterStatementMemberFilter

type CertificateFilterStatementMemberFilter struct {
	Value CertificateFilter
	// contains filtered or unexported fields
}

A single certificate filter.

type CertificateFilterStatementMemberNot

type CertificateFilterStatementMemberNot struct {
	Value CertificateFilterStatement
	// contains filtered or unexported fields
}

A filter statement that must not be true.

type CertificateFilterStatementMemberOr

type CertificateFilterStatementMemberOr struct {
	Value []CertificateFilterStatement
	// contains filtered or unexported fields
}

A list of filter statements where at least one must be true.

type CertificateManagedBy

type CertificateManagedBy string
const (
	CertificateManagedByCloudfront CertificateManagedBy = "CLOUDFRONT"
)

Enum values for CertificateManagedBy

func (CertificateManagedBy) Values

Values returns all known values for CertificateManagedBy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CertificateMetadata

type CertificateMetadata interface {
	// contains filtered or unexported methods
}

Contains metadata about a certificate. Currently supports ACM certificate metadata.

The following types satisfy this interface:

CertificateMetadataMemberAcmCertificateMetadata
Example (OutputUsage)

Code:play 

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/acm/types"
)

func main() {
	var union types.CertificateMetadata
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.CertificateMetadataMemberAcmCertificateMetadata:
		_ = v.Value // Value is types.AcmCertificateMetadata

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type CertificateMetadataMemberAcmCertificateMetadata

type CertificateMetadataMemberAcmCertificateMetadata struct {
	Value AcmCertificateMetadata
	// contains filtered or unexported fields
}

Metadata for an ACM certificate.

type CertificateOptions

type CertificateOptions struct {

	// You can opt out of certificate transparency logging by specifying the DISABLED
	// option. Opt in by specifying ENABLED .
	CertificateTransparencyLoggingPreference CertificateTransparencyLoggingPreference

	// You can opt in to allow the export of your certificates by specifying ENABLED .
	// You cannot update the value of Export after the the certificate is created.
	Export CertificateExport
	// contains filtered or unexported fields
}

Structure that contains options for your certificate. You can use this structure to specify whether to opt in to or out of certificate transparency logging and export your certificate.

Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see Certificate Transparency Logging.

You can export public ACM certificates to use with Amazon Web Services services as well as outside Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate.

type CertificateSearchResult

type CertificateSearchResult struct {

	// The Amazon Resource Name (ARN) of the certificate.
	CertificateArn *string

	// ACM-specific metadata about the certificate.
	CertificateMetadata CertificateMetadata

	// X.509 certificate attributes such as subject, issuer, and validity period.
	X509Attributes *X509Attributes
	// contains filtered or unexported fields
}

Contains information about a certificate returned by the SearchCertificates action. This structure includes the certificate ARN, X.509 attributes, and ACM metadata.

type CertificateStatus

type CertificateStatus string
const (
	CertificateStatusPendingValidation  CertificateStatus = "PENDING_VALIDATION"
	CertificateStatusIssued             CertificateStatus = "ISSUED"
	CertificateStatusInactive           CertificateStatus = "INACTIVE"
	CertificateStatusExpired            CertificateStatus = "EXPIRED"
	CertificateStatusValidationTimedOut CertificateStatus = "VALIDATION_TIMED_OUT"
	CertificateStatusRevoked            CertificateStatus = "REVOKED"
	CertificateStatusFailed             CertificateStatus = "FAILED"
)

Enum values for CertificateStatus

func (CertificateStatus) Values

Values returns all known values for CertificateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CertificateSummary

type CertificateSummary struct {

	// Amazon Resource Name (ARN) of the certificate. This is of the form:
	//
	//     arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
	//
	// For more information about ARNs, see [Amazon Resource Names (ARNs)].
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	CertificateArn *string

	// The time at which the certificate was requested.
	CreatedAt *time.Time

	// Fully qualified domain name (FQDN), such as www.example.com or example.com, for
	// the certificate.
	DomainName *string

	// Indicates if export is enabled for the certificate.
	ExportOption CertificateExport

	// Indicates whether the certificate has been exported. This value exists only
	// when the certificate type is PRIVATE .
	Exported *bool

	// Contains a list of Extended Key Usage X.509 v3 extension objects. Each object
	// specifies a purpose for which the certificate public key can be used and
	// consists of a name and an object identifier (OID).
	ExtendedKeyUsages []ExtendedKeyUsageName

	// When called by [ListCertificates], indicates whether the full list of subject alternative names
	// has been included in the response. If false, the response includes all of the
	// subject alternative names included in the certificate. If true, the response
	// only includes the first 100 subject alternative names included in the
	// certificate. To display the full list of subject alternative names, use [DescribeCertificate].
	//
	// [DescribeCertificate]: https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html
	// [ListCertificates]: https://docs.aws.amazon.com/acm/latest/APIReference/API_ListCertificates.html
	HasAdditionalSubjectAlternativeNames *bool

	// The date and time when the certificate was imported. This value exists only
	// when the certificate type is IMPORTED .
	ImportedAt *time.Time

	// Indicates whether the certificate is currently in use by any Amazon Web
	// Services resources.
	InUse *bool

	// The time at which the certificate was issued. This value exists only when the
	// certificate type is AMAZON_ISSUED .
	IssuedAt *time.Time

	// The algorithm that was used to generate the public-private key pair.
	KeyAlgorithm KeyAlgorithm

	// A list of Key Usage X.509 v3 extension objects. Each object is a string value
	// that identifies the purpose of the public key contained in the certificate.
	// Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT,
	// NON_REPUDIATION, and more.
	KeyUsages []KeyUsageName

	// Identifies the Amazon Web Services service that manages the certificate issued
	// by ACM.
	ManagedBy CertificateManagedBy

	// The time after which the certificate is not valid.
	NotAfter *time.Time

	// The time before which the certificate is not valid.
	NotBefore *time.Time

	// Specifies whether the certificate is eligible for renewal. At this time, only
	// exported private certificates can be renewed with the RenewCertificatecommand.
	RenewalEligibility RenewalEligibility

	// The time at which the certificate was revoked. This value exists only when the
	// certificate status is REVOKED .
	RevokedAt *time.Time

	// The status of the certificate.
	//
	// A certificate enters status PENDING_VALIDATION upon being requested, unless it
	// fails for any of the reasons given in the troubleshooting topic [Certificate request fails]. ACM makes
	// repeated attempts to validate a certificate for 72 hours and then times out. If
	// a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request,
	// correct the issue with [DNS validation]or [Email validation], and try again. If validation succeeds, the
	// certificate enters status ISSUED.
	//
	// [DNS validation]: https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html
	// [Certificate request fails]: https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html
	// [Email validation]: https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html
	Status CertificateStatus

	// One or more domain names (subject alternative names) included in the
	// certificate. This list contains the domain names that are bound to the public
	// key that is contained in the certificate. The subject alternative names include
	// the canonical domain name (CN) of the certificate and additional domain names
	// that can be used to connect to the website.
	//
	// When called by [ListCertificates], this parameter will only return the first 100 subject
	// alternative names included in the certificate. To display the full list of
	// subject alternative names, use [DescribeCertificate].
	//
	// [DescribeCertificate]: https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html
	// [ListCertificates]: https://docs.aws.amazon.com/acm/latest/APIReference/API_ListCertificates.html
	SubjectAlternativeNameSummaries []string

	// The source of the certificate. For certificates provided by ACM, this value is
	// AMAZON_ISSUED . For certificates that you imported with ImportCertificate, this value is IMPORTED
	// . ACM does not provide [managed renewal]for imported certificates. For more information about
	// the differences between certificates that you import and those that ACM
	// provides, see [Importing Certificates]in the Certificate Manager User Guide.
	//
	// [Importing Certificates]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
	// [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html
	Type CertificateType
	// contains filtered or unexported fields
}

This structure is returned in the response object of ListCertificates action.

type CertificateTransparencyLoggingPreference

type CertificateTransparencyLoggingPreference string
const (
	CertificateTransparencyLoggingPreferenceEnabled  CertificateTransparencyLoggingPreference = "ENABLED"
	CertificateTransparencyLoggingPreferenceDisabled CertificateTransparencyLoggingPreference = "DISABLED"
)

Enum values for CertificateTransparencyLoggingPreference

func (CertificateTransparencyLoggingPreference) Values

Values returns all known values for CertificateTransparencyLoggingPreference. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CertificateType

type CertificateType string
const (
	CertificateTypeImported     CertificateType = "IMPORTED"
	CertificateTypeAmazonIssued CertificateType = "AMAZON_ISSUED"
	CertificateTypePrivate      CertificateType = "PRIVATE"
)

Enum values for CertificateType

func (CertificateType) Values

func (CertificateType) Values() []CertificateType

Values returns all known values for CertificateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CommonNameFilter

type CommonNameFilter struct {

	// The comparison operator to use.
	//
	// This member is required.
	ComparisonOperator ComparisonOperator

	// The value to match against.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Filters certificates by common name.

type ComparisonOperator

type ComparisonOperator string
const (
	ComparisonOperatorContains ComparisonOperator = "CONTAINS"
	ComparisonOperatorEquals   ComparisonOperator = "EQUALS"
)

Enum values for ComparisonOperator

func (ComparisonOperator) Values

Values returns all known values for ComparisonOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type CustomAttribute

type CustomAttribute struct {

	// Specifies the object identifier (OID) of the attribute type of the relative
	// distinguished name (RDN).
	ObjectIdentifier *string

	// Specifies the attribute value of relative distinguished name (RDN).
	Value *string
	// contains filtered or unexported fields
}

Defines the X.500 relative distinguished name (RDN).

type DistinguishedName

type DistinguishedName struct {

	// The common name (CN) attribute.
	CommonName *string

	// The country (C) attribute.
	Country *string

	// A list of custom attributes in the distinguished name. Each custom attribute
	// contains an object identifier (OID) and its corresponding value.
	CustomAttributes []CustomAttribute

	// The distinguished name qualifier attribute.
	DistinguishedNameQualifier *string

	// The domain component attributes.
	DomainComponents []string

	// The generation qualifier attribute.
	GenerationQualifier *string

	// The given name attribute.
	GivenName *string

	// The initials attribute.
	Initials *string

	// The locality (L) attribute.
	Locality *string

	// The organization (O) attribute.
	Organization *string

	// The organizational unit (OU) attribute.
	OrganizationalUnit *string

	// The pseudonym attribute.
	Pseudonym *string

	// The serial number attribute.
	SerialNumber *string

	// The state or province (ST) attribute.
	State *string

	// The surname attribute.
	Surname *string

	// The title attribute.
	Title *string
	// contains filtered or unexported fields
}

Contains X.500 distinguished name information.

type DnsNameFilter

type DnsNameFilter struct {

	// The comparison operator to use.
	//
	// This member is required.
	ComparisonOperator ComparisonOperator

	// The DNS name value to match against.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Filters certificates by DNS name.

type DomainStatus

type DomainStatus string
const (
	DomainStatusPendingValidation DomainStatus = "PENDING_VALIDATION"
	DomainStatusSuccess           DomainStatus = "SUCCESS"
	DomainStatusFailed            DomainStatus = "FAILED"
)

Enum values for DomainStatus

func (DomainStatus) Values

func (DomainStatus) Values() []DomainStatus

Values returns all known values for DomainStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DomainValidation

type DomainValidation struct {

	// A fully qualified domain name (FQDN) in the certificate. For example,
	// www.example.com or example.com .
	//
	// This member is required.
	DomainName *string

	// Contains information for HTTP-based domain validation of certificates requested
	// through Amazon CloudFront and issued by ACM. This field exists only when the
	// certificate type is AMAZON_ISSUED and the validation method is HTTP .
	HttpRedirect *HttpRedirect

	// Contains the CNAME record that you add to your DNS database for domain
	// validation. For more information, see [Use DNS to Validate Domain Ownership].
	//
	// The CNAME information that you need does not include the name of your domain.
	// If you include your domain name in the DNS database CNAME record, validation
	// fails. For example, if the name is
	// _a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com , only
	// _a79865eb4cd1a6ab990a45779b4e0b96 must be used.
	//
	// [Use DNS to Validate Domain Ownership]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html
	ResourceRecord *ResourceRecord

	// The domain name that ACM used to send domain validation emails.
	ValidationDomain *string

	// A list of email addresses that ACM used to send domain validation emails.
	ValidationEmails []string

	// Specifies the domain validation method.
	ValidationMethod ValidationMethod

	// The validation status of the domain name. This can be one of the following
	// values:
	//
	//   - PENDING_VALIDATION
	//
	//   - SUCCESS
	//
	//   - FAILED
	ValidationStatus DomainStatus
	// contains filtered or unexported fields
}

Contains information about the validation of each domain name in the certificate.

type DomainValidationOption

type DomainValidationOption struct {

	// A fully qualified domain name (FQDN) in the certificate request.
	//
	// This member is required.
	DomainName *string

	// The domain name that you want ACM to use to send you validation emails. This
	// domain name is the suffix of the email addresses that you want ACM to use. This
	// must be the same as the DomainName value or a superdomain of the DomainName
	// value. For example, if you request a certificate for testing.example.com , you
	// can specify example.com for this value. In that case, ACM sends domain
	// validation emails to the following five addresses:
	//
	//   - admin@example.com
	//
	//   - administrator@example.com
	//
	//   - hostmaster@example.com
	//
	//   - postmaster@example.com
	//
	//   - webmaster@example.com
	//
	// This member is required.
	ValidationDomain *string
	// contains filtered or unexported fields
}

Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.

type ExpiryEventsConfiguration

type ExpiryEventsConfiguration struct {

	// Specifies the number of days prior to certificate expiration when ACM starts
	// generating EventBridge events. ACM sends one event per day per certificate
	// until the certificate expires. By default, accounts receive events starting 45
	// days before certificate expiration.
	DaysBeforeExpiry *int32
	// contains filtered or unexported fields
}

Object containing expiration events options associated with an Amazon Web Services account.

type ExtendedKeyUsage

type ExtendedKeyUsage struct {

	// The name of an Extended Key Usage value.
	Name ExtendedKeyUsageName

	// An object identifier (OID) for the extension value. OIDs are strings of numbers
	// separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280.
	//
	//   - 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)
	//
	//   - 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)
	//
	//   - 1.3.6.1.5.5.7.3.3 (CODE_SIGNING)
	//
	//   - 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)
	//
	//   - 1.3.6.1.5.5.7.3.8 (TIME_STAMPING)
	//
	//   - 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)
	//
	//   - 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)
	//
	//   - 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)
	//
	//   - 1.3.6.1.5.5.7.3.7 (IPSEC_USER)
	OID *string
	// contains filtered or unexported fields
}

The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.

type ExtendedKeyUsageName

type ExtendedKeyUsageName string
const (
	ExtendedKeyUsageNameTlsWebServerAuthentication ExtendedKeyUsageName = "TLS_WEB_SERVER_AUTHENTICATION"
	ExtendedKeyUsageNameTlsWebClientAuthentication ExtendedKeyUsageName = "TLS_WEB_CLIENT_AUTHENTICATION"
	ExtendedKeyUsageNameCodeSigning                ExtendedKeyUsageName = "CODE_SIGNING"
	ExtendedKeyUsageNameEmailProtection            ExtendedKeyUsageName = "EMAIL_PROTECTION"
	ExtendedKeyUsageNameTimeStamping               ExtendedKeyUsageName = "TIME_STAMPING"
	ExtendedKeyUsageNameOcspSigning                ExtendedKeyUsageName = "OCSP_SIGNING"
	ExtendedKeyUsageNameIpsecEndSystem             ExtendedKeyUsageName = "IPSEC_END_SYSTEM"
	ExtendedKeyUsageNameIpsecTunnel                ExtendedKeyUsageName = "IPSEC_TUNNEL"
	ExtendedKeyUsageNameIpsecUser                  ExtendedKeyUsageName = "IPSEC_USER"
	ExtendedKeyUsageNameAny                        ExtendedKeyUsageName = "ANY"
	ExtendedKeyUsageNameNone                       ExtendedKeyUsageName = "NONE"
	ExtendedKeyUsageNameCustom                     ExtendedKeyUsageName = "CUSTOM"
)

Enum values for ExtendedKeyUsageName

func (ExtendedKeyUsageName) Values

Values returns all known values for ExtendedKeyUsageName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FailureReason

type FailureReason string
const (
	FailureReasonNoAvailableContacts            FailureReason = "NO_AVAILABLE_CONTACTS"
	FailureReasonAdditionalVerificationRequired FailureReason = "ADDITIONAL_VERIFICATION_REQUIRED"
	FailureReasonDomainNotAllowed               FailureReason = "DOMAIN_NOT_ALLOWED"
	FailureReasonInvalidPublicDomain            FailureReason = "INVALID_PUBLIC_DOMAIN"
	FailureReasonDomainValidationDenied         FailureReason = "DOMAIN_VALIDATION_DENIED"
	FailureReasonCaaError                       FailureReason = "CAA_ERROR"
	FailureReasonPcaLimitExceeded               FailureReason = "PCA_LIMIT_EXCEEDED"
	FailureReasonPcaInvalidArn                  FailureReason = "PCA_INVALID_ARN"
	FailureReasonPcaInvalidState                FailureReason = "PCA_INVALID_STATE"
	FailureReasonPcaRequestFailed               FailureReason = "PCA_REQUEST_FAILED"
	FailureReasonPcaNameConstraintsValidation   FailureReason = "PCA_NAME_CONSTRAINTS_VALIDATION"
	FailureReasonPcaResourceNotFound            FailureReason = "PCA_RESOURCE_NOT_FOUND"
	FailureReasonPcaInvalidArgs                 FailureReason = "PCA_INVALID_ARGS"
	FailureReasonPcaInvalidDuration             FailureReason = "PCA_INVALID_DURATION"
	FailureReasonPcaAccessDenied                FailureReason = "PCA_ACCESS_DENIED"
	FailureReasonSlrNotFound                    FailureReason = "SLR_NOT_FOUND"
	FailureReasonOther                          FailureReason = "OTHER"
)

Enum values for FailureReason

func (FailureReason) Values

func (FailureReason) Values() []FailureReason

Values returns all known values for FailureReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Filters

type Filters struct {

	// Specify ENABLED or DISABLED to identify certificates that can be exported.
	ExportOption CertificateExport

	// Specify one or more ExtendedKeyUsage extension values.
	ExtendedKeyUsage []ExtendedKeyUsageName

	// Specify one or more algorithms that can be used to generate key pairs.
	//
	// Default filtering returns only RSA_1024 and RSA_2048 certificates that have at
	// least one domain. To return other certificate types, provide the desired type
	// signatures in a comma-separated list. For example, "keyTypes":
	// ["RSA_2048","RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.
	KeyTypes []KeyAlgorithm

	// Specify one or more KeyUsage extension values.
	KeyUsage []KeyUsageName

	// Identifies the Amazon Web Services service that manages the certificate issued
	// by ACM.
	ManagedBy CertificateManagedBy
	// contains filtered or unexported fields
}

This structure can be used in the ListCertificates action to filter the output of the certificate list.

type GeneralName

type GeneralName interface {
	// contains filtered or unexported methods
}

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should be provided.

The following types satisfy this interface:

GeneralNameMemberDirectoryName
GeneralNameMemberDnsName
GeneralNameMemberIpAddress
GeneralNameMemberOtherName
GeneralNameMemberRegisteredId
GeneralNameMemberRfc822Name
GeneralNameMemberUniformResourceIdentifier
Example (OutputUsage)

Code:play 

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/acm/types"
)

func main() {
	var union types.GeneralName
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.GeneralNameMemberDirectoryName:
		_ = v.Value // Value is types.DistinguishedName

	case *types.GeneralNameMemberDnsName:
		_ = v.Value // Value is string

	case *types.GeneralNameMemberIpAddress:
		_ = v.Value // Value is string

	case *types.GeneralNameMemberOtherName:
		_ = v.Value // Value is types.OtherName

	case *types.GeneralNameMemberRegisteredId:
		_ = v.Value // Value is string

	case *types.GeneralNameMemberRfc822Name:
		_ = v.Value // Value is string

	case *types.GeneralNameMemberUniformResourceIdentifier:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type GeneralNameMemberDirectoryName

type GeneralNameMemberDirectoryName struct {
	Value DistinguishedName
	// contains filtered or unexported fields
}

Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

type GeneralNameMemberDnsName

type GeneralNameMemberDnsName struct {
	Value string
	// contains filtered or unexported fields
}

Represents GeneralName as a DNS name.

type GeneralNameMemberIpAddress

type GeneralNameMemberIpAddress struct {
	Value string
	// contains filtered or unexported fields
}

Represents GeneralName as an IPv4 or IPv6 address.

type GeneralNameMemberOtherName

type GeneralNameMemberOtherName struct {
	Value OtherName
	// contains filtered or unexported fields
}

Represents GeneralName using an OtherName object.

type GeneralNameMemberRegisteredId

type GeneralNameMemberRegisteredId struct {
	Value string
	// contains filtered or unexported fields
}

Represents GeneralName as an object identifier (OID).

type GeneralNameMemberRfc822Name

type GeneralNameMemberRfc822Name struct {
	Value string
	// contains filtered or unexported fields
}

Represents GeneralName as an RFC 822 email address.

type GeneralNameMemberUniformResourceIdentifier

type GeneralNameMemberUniformResourceIdentifier struct {
	Value string
	// contains filtered or unexported fields
}

Represents GeneralName as a URI.

type HttpRedirect

type HttpRedirect struct {

	// The URL including the domain to be validated. The certificate authority sends
	// GET requests here during validation.
	RedirectFrom *string

	// The URL hosting the validation token. RedirectFrom must return this content or
	// redirect here.
	RedirectTo *string
	// contains filtered or unexported fields
}

Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP .

type InvalidArgsException

type InvalidArgsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One or more of request parameters specified is not valid.

func (*InvalidArgsException) Error

func (e *InvalidArgsException) Error() string

func (*InvalidArgsException) ErrorCode

func (e *InvalidArgsException) ErrorCode() string

func (*InvalidArgsException) ErrorFault

func (e *InvalidArgsException) ErrorFault() smithy.ErrorFault

func (*InvalidArgsException) ErrorMessage

func (e *InvalidArgsException) ErrorMessage() string

type InvalidArnException

type InvalidArnException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

func (*InvalidArnException) Error

func (e *InvalidArnException) Error() string

func (*InvalidArnException) ErrorCode

func (e *InvalidArnException) ErrorCode() string

func (*InvalidArnException) ErrorFault

func (e *InvalidArnException) ErrorFault() smithy.ErrorFault

func (*InvalidArnException) ErrorMessage

func (e *InvalidArnException) ErrorMessage() string

type InvalidDomainValidationOptionsException

type InvalidDomainValidationOptionsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One or more values in the DomainValidationOption structure is incorrect.

func (*InvalidDomainValidationOptionsException) Error

func (*InvalidDomainValidationOptionsException) ErrorCode

func (*InvalidDomainValidationOptionsException) ErrorFault

func (*InvalidDomainValidationOptionsException) ErrorMessage

type InvalidParameterException

type InvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An input parameter was invalid.

func (*InvalidParameterException) Error

func (e *InvalidParameterException) Error() string

func (*InvalidParameterException) ErrorCode

func (e *InvalidParameterException) ErrorCode() string

func (*InvalidParameterException) ErrorFault

func (*InvalidParameterException) ErrorMessage

func (e *InvalidParameterException) ErrorMessage() string

type InvalidStateException

type InvalidStateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Processing has reached an invalid state.

func (*InvalidStateException) Error

func (e *InvalidStateException) Error() string

func (*InvalidStateException) ErrorCode

func (e *InvalidStateException) ErrorCode() string

func (*InvalidStateException) ErrorFault

func (e *InvalidStateException) ErrorFault() smithy.ErrorFault

func (*InvalidStateException) ErrorMessage

func (e *InvalidStateException) ErrorMessage() string

type InvalidTagException

type InvalidTagException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws: .

func (*InvalidTagException) Error

func (e *InvalidTagException) Error() string

func (*InvalidTagException) ErrorCode

func (e *InvalidTagException) ErrorCode() string

func (*InvalidTagException) ErrorFault

func (e *InvalidTagException) ErrorFault() smithy.ErrorFault

func (*InvalidTagException) ErrorMessage

func (e *InvalidTagException) ErrorMessage() string

type KeyAlgorithm

type KeyAlgorithm string
const (
	KeyAlgorithmRsa1024      KeyAlgorithm = "RSA_1024"
	KeyAlgorithmRsa2048      KeyAlgorithm = "RSA_2048"
	KeyAlgorithmRsa3072      KeyAlgorithm = "RSA_3072"
	KeyAlgorithmRsa4096      KeyAlgorithm = "RSA_4096"
	KeyAlgorithmEcPrime256v1 KeyAlgorithm = "EC_prime256v1"
	KeyAlgorithmEcSecp384r1  KeyAlgorithm = "EC_secp384r1"
	KeyAlgorithmEcSecp521r1  KeyAlgorithm = "EC_secp521r1"
)

Enum values for KeyAlgorithm

func (KeyAlgorithm) Values

func (KeyAlgorithm) Values() []KeyAlgorithm

Values returns all known values for KeyAlgorithm. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KeyUsage

type KeyUsage struct {

	// A string value that contains a Key Usage extension name.
	Name KeyUsageName
	// contains filtered or unexported fields
}

The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.

type KeyUsageName

type KeyUsageName string
const (
	KeyUsageNameDigitalSignature   KeyUsageName = "DIGITAL_SIGNATURE"
	KeyUsageNameNonRepudation      KeyUsageName = "NON_REPUDIATION"
	KeyUsageNameKeyEncipherment    KeyUsageName = "KEY_ENCIPHERMENT"
	KeyUsageNameDataEncipherment   KeyUsageName = "DATA_ENCIPHERMENT"
	KeyUsageNameKeyAgreement       KeyUsageName = "KEY_AGREEMENT"
	KeyUsageNameCertificateSigning KeyUsageName = "CERTIFICATE_SIGNING"
	KeyUsageNameCrlSigning         KeyUsageName = "CRL_SIGNING"
	KeyUsageNameEnchiperOnly       KeyUsageName = "ENCIPHER_ONLY"
	KeyUsageNameDecipherOnly       KeyUsageName = "DECIPHER_ONLY"
	KeyUsageNameAny                KeyUsageName = "ANY"
	KeyUsageNameCustom             KeyUsageName = "CUSTOM"
)

Enum values for KeyUsageName

func (KeyUsageName) Values

func (KeyUsageName) Values() []KeyUsageName

Values returns all known values for KeyUsageName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LimitExceededException

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An ACM quota has been exceeded.

func (*LimitExceededException) Error

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage

func (e *LimitExceededException) ErrorMessage() string

type OtherName

type OtherName struct {

	// Specifies an OID.
	ObjectIdentifier *string

	// Specifies an OID value.
	Value *string
	// contains filtered or unexported fields
}

Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and value. For more information, see NIST's definition of Object Identifier (OID).

type RecordType

type RecordType string
const (
	RecordTypeCname RecordType = "CNAME"
)

Enum values for RecordType

func (RecordType) Values

func (RecordType) Values() []RecordType

Values returns all known values for RecordType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RenewalEligibility

type RenewalEligibility string
const (
	RenewalEligibilityEligible   RenewalEligibility = "ELIGIBLE"
	RenewalEligibilityIneligible RenewalEligibility = "INELIGIBLE"
)

Enum values for RenewalEligibility

func (RenewalEligibility) Values

Values returns all known values for RenewalEligibility. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RenewalStatus

type RenewalStatus string
const (
	RenewalStatusPendingAutoRenewal RenewalStatus = "PENDING_AUTO_RENEWAL"
	RenewalStatusPendingValidation  RenewalStatus = "PENDING_VALIDATION"
	RenewalStatusSuccess            RenewalStatus = "SUCCESS"
	RenewalStatusFailed             RenewalStatus = "FAILED"
)

Enum values for RenewalStatus

func (RenewalStatus) Values

func (RenewalStatus) Values() []RenewalStatus

Values returns all known values for RenewalStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RenewalSummary

type RenewalSummary struct {

	// Contains information about the validation of each domain name in the
	// certificate, as it pertains to ACM's [managed renewal]. This is different from the initial
	// validation that occurs as a result of the RequestCertificaterequest. This field exists only when
	// the certificate type is AMAZON_ISSUED .
	//
	// [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html
	//
	// This member is required.
	DomainValidationOptions []DomainValidation

	// The status of ACM's [managed renewal] of the certificate.
	//
	// [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html
	//
	// This member is required.
	RenewalStatus RenewalStatus

	// The time at which the renewal summary was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The reason that a renewal request was unsuccessful.
	RenewalStatusReason FailureReason
	// contains filtered or unexported fields
}

Contains information about the status of ACM's managed renewal for the certificate. This structure exists only when the certificate type is AMAZON_ISSUED .

type RequestInProgressException

type RequestInProgressException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The certificate request is in process and the certificate in your account has not yet been issued.

func (*RequestInProgressException) Error

func (*RequestInProgressException) ErrorCode

func (e *RequestInProgressException) ErrorCode() string

func (*RequestInProgressException) ErrorFault

func (*RequestInProgressException) ErrorMessage

func (e *RequestInProgressException) ErrorMessage() string

type ResourceInUseException

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The certificate is in use by another Amazon Web Services service in the caller's account. Remove the association and try again.

func (*ResourceInUseException) Error

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault

func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

func (*ResourceInUseException) ErrorMessage

func (e *ResourceInUseException) ErrorMessage() string

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceRecord

type ResourceRecord struct {

	// The name of the DNS record to create in your domain. This is supplied by ACM.
	//
	// This member is required.
	Name *string

	// The type of DNS record. Currently this can be CNAME .
	//
	// This member is required.
	Type RecordType

	// The value of the CNAME record to add to your DNS database. This is supplied by
	// ACM.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the DescribeCertificateaction.

type RevocationReason

type RevocationReason string
const (
	RevocationReasonUnspecified          RevocationReason = "UNSPECIFIED"
	RevocationReasonKeyCompromise        RevocationReason = "KEY_COMPROMISE"
	RevocationReasonCaCompromise         RevocationReason = "CA_COMPROMISE"
	RevocationReasonAffiliationChanged   RevocationReason = "AFFILIATION_CHANGED"
	RevocationReasonSuperceded           RevocationReason = "SUPERCEDED"
	RevocationReasonSuperseded           RevocationReason = "SUPERSEDED"
	RevocationReasonCessationOfOperation RevocationReason = "CESSATION_OF_OPERATION"
	RevocationReasonCertificateHold      RevocationReason = "CERTIFICATE_HOLD"
	RevocationReasonRemoveFromCrl        RevocationReason = "REMOVE_FROM_CRL"
	RevocationReasonPrivilegeWithdrawn   RevocationReason = "PRIVILEGE_WITHDRAWN"
	RevocationReasonAACompromise         RevocationReason = "A_A_COMPROMISE"
)

Enum values for RevocationReason

func (RevocationReason) Values

Values returns all known values for RevocationReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SearchCertificatesSortBy

type SearchCertificatesSortBy string
const (
	SearchCertificatesSortByCreatedAt          SearchCertificatesSortBy = "CREATED_AT"
	SearchCertificatesSortByNotAfter           SearchCertificatesSortBy = "NOT_AFTER"
	SearchCertificatesSortByStatus             SearchCertificatesSortBy = "STATUS"
	SearchCertificatesSortByRenewalStatus      SearchCertificatesSortBy = "RENEWAL_STATUS"
	SearchCertificatesSortByExported           SearchCertificatesSortBy = "EXPORTED"
	SearchCertificatesSortByInUse              SearchCertificatesSortBy = "IN_USE"
	SearchCertificatesSortByNotBefore          SearchCertificatesSortBy = "NOT_BEFORE"
	SearchCertificatesSortByKeyAlgorithm       SearchCertificatesSortBy = "KEY_ALGORITHM"
	SearchCertificatesSortByType               SearchCertificatesSortBy = "TYPE"
	SearchCertificatesSortByCertificateArn     SearchCertificatesSortBy = "CERTIFICATE_ARN"
	SearchCertificatesSortByCommonName         SearchCertificatesSortBy = "COMMON_NAME"
	SearchCertificatesSortByRevokedAt          SearchCertificatesSortBy = "REVOKED_AT"
	SearchCertificatesSortByRenewalEligibility SearchCertificatesSortBy = "RENEWAL_ELIGIBILITY"
	SearchCertificatesSortByIssuedAt           SearchCertificatesSortBy = "ISSUED_AT"
	SearchCertificatesSortByManagedBy          SearchCertificatesSortBy = "MANAGED_BY"
	SearchCertificatesSortByExportOption       SearchCertificatesSortBy = "EXPORT_OPTION"
	SearchCertificatesSortByValidationMethod   SearchCertificatesSortBy = "VALIDATION_METHOD"
	SearchCertificatesSortByImportedAt         SearchCertificatesSortBy = "IMPORTED_AT"
)

Enum values for SearchCertificatesSortBy

func (SearchCertificatesSortBy) Values

Values returns all known values for SearchCertificatesSortBy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SearchCertificatesSortOrder

type SearchCertificatesSortOrder string
const (
	SearchCertificatesSortOrderAscending  SearchCertificatesSortOrder = "ASCENDING"
	SearchCertificatesSortOrderDescending SearchCertificatesSortOrder = "DESCENDING"
)

Enum values for SearchCertificatesSortOrder

func (SearchCertificatesSortOrder) Values

Values returns all known values for SearchCertificatesSortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SortBy

type SortBy string
const (
	SortByCreatedAt SortBy = "CREATED_AT"
)

Enum values for SortBy

func (SortBy) Values

func (SortBy) Values() []SortBy

Values returns all known values for SortBy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SortOrder

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SubjectAlternativeNameFilter

type SubjectAlternativeNameFilter interface {
	// contains filtered or unexported methods
}

Filters certificates by subject alternative name attributes.

The following types satisfy this interface:

SubjectAlternativeNameFilterMemberDnsName
Example (OutputUsage)

Code:play 

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/acm/types"
)

func main() {
	var union types.SubjectAlternativeNameFilter
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SubjectAlternativeNameFilterMemberDnsName:
		_ = v.Value // Value is types.DnsNameFilter

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type SubjectAlternativeNameFilterMemberDnsName

type SubjectAlternativeNameFilterMemberDnsName struct {
	Value DnsNameFilter
	// contains filtered or unexported fields
}

Filter by DNS name in subject alternative names.

type SubjectFilter

type SubjectFilter interface {
	// contains filtered or unexported methods
}

Filters certificates by subject attributes.

The following types satisfy this interface:

SubjectFilterMemberCommonName
Example (OutputUsage)

Code:play 

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/acm/types"
)

func main() {
	var union types.SubjectFilter
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SubjectFilterMemberCommonName:
		_ = v.Value // Value is types.CommonNameFilter

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type SubjectFilterMemberCommonName

type SubjectFilterMemberCommonName struct {
	Value CommonNameFilter
	// contains filtered or unexported fields
}

Filter by common name in the subject.

type Tag

type Tag struct {

	// The key of the tag.
	//
	// This member is required.
	Key *string

	// The value of the tag.
	Value *string
	// contains filtered or unexported fields
}

A key-value pair that identifies or specifies metadata about an ACM resource.

type TagPolicyException

type TagPolicyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A specified tag did not comply with an existing tag policy and was rejected.

func (*TagPolicyException) Error

func (e *TagPolicyException) Error() string

func (*TagPolicyException) ErrorCode

func (e *TagPolicyException) ErrorCode() string

func (*TagPolicyException) ErrorFault

func (e *TagPolicyException) ErrorFault() smithy.ErrorFault

func (*TagPolicyException) ErrorMessage

func (e *TagPolicyException) ErrorMessage() string

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ThrottlingReasons []ThrottlingReason
	// contains filtered or unexported fields
}

The request was denied because it exceeded a quota.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type ThrottlingReason

type ThrottlingReason struct {

	// A description of why a request was throttled.
	Reason *string

	// The resource that causes the request to be throttled.
	Resource *string
	// contains filtered or unexported fields
}

A description of why a request was throttled.

type TimestampRange

type TimestampRange struct {

	// The end of the time range. This value is inclusive.
	End *time.Time

	// The start of the time range. This value is inclusive.
	Start *time.Time
	// contains filtered or unexported fields
}

Specifies a time range for filtering certificates.

type TooManyTagsException

type TooManyTagsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request contains too many tags. Try the request again with fewer tags.

func (*TooManyTagsException) Error

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage

func (e *TooManyTagsException) ErrorMessage() string

type UnknownUnionMember

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The supplied input failed to satisfy constraints of an Amazon Web Services service.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

type ValidationMethod

type ValidationMethod string
const (
	ValidationMethodEmail ValidationMethod = "EMAIL"
	ValidationMethodDns   ValidationMethod = "DNS"
	ValidationMethodHttp  ValidationMethod = "HTTP"
)

Enum values for ValidationMethod

func (ValidationMethod) Values

Values returns all known values for ValidationMethod. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type X509AttributeFilter

type X509AttributeFilter interface {
	// contains filtered or unexported methods
}

Filters certificates by X.509 attributes.

The following types satisfy this interface:

X509AttributeFilterMemberExtendedKeyUsage
X509AttributeFilterMemberKeyAlgorithm
X509AttributeFilterMemberKeyUsage
X509AttributeFilterMemberNotAfter
X509AttributeFilterMemberNotBefore
X509AttributeFilterMemberSerialNumber
X509AttributeFilterMemberSubject
X509AttributeFilterMemberSubjectAlternativeName
Example (OutputUsage)

Code:play 

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/acm/types"
)

func main() {
	var union types.X509AttributeFilter
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.X509AttributeFilterMemberExtendedKeyUsage:
		_ = v.Value // Value is types.ExtendedKeyUsageName

	case *types.X509AttributeFilterMemberKeyAlgorithm:
		_ = v.Value // Value is types.KeyAlgorithm

	case *types.X509AttributeFilterMemberKeyUsage:
		_ = v.Value // Value is types.KeyUsageName

	case *types.X509AttributeFilterMemberNotAfter:
		_ = v.Value // Value is types.TimestampRange

	case *types.X509AttributeFilterMemberNotBefore:
		_ = v.Value // Value is types.TimestampRange

	case *types.X509AttributeFilterMemberSerialNumber:
		_ = v.Value // Value is string

	case *types.X509AttributeFilterMemberSubject:
		_ = v.Value // Value is types.SubjectFilter

	case *types.X509AttributeFilterMemberSubjectAlternativeName:
		_ = v.Value // Value is types.SubjectAlternativeNameFilter

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type X509AttributeFilterMemberExtendedKeyUsage

type X509AttributeFilterMemberExtendedKeyUsage struct {
	Value ExtendedKeyUsageName
	// contains filtered or unexported fields
}

Filter by extended key usage.

type X509AttributeFilterMemberKeyAlgorithm

type X509AttributeFilterMemberKeyAlgorithm struct {
	Value KeyAlgorithm
	// contains filtered or unexported fields
}

Filter by key algorithm.

type X509AttributeFilterMemberKeyUsage

type X509AttributeFilterMemberKeyUsage struct {
	Value KeyUsageName
	// contains filtered or unexported fields
}

Filter by key usage.

type X509AttributeFilterMemberNotAfter

type X509AttributeFilterMemberNotAfter struct {
	Value TimestampRange
	// contains filtered or unexported fields
}

Filter by certificate expiration date. The start date is inclusive.

type X509AttributeFilterMemberNotBefore

type X509AttributeFilterMemberNotBefore struct {
	Value TimestampRange
	// contains filtered or unexported fields
}

Filter by certificate validity start date. The start date is inclusive.

type X509AttributeFilterMemberSerialNumber

type X509AttributeFilterMemberSerialNumber struct {
	Value string
	// contains filtered or unexported fields
}

Filter by serial number.

type X509AttributeFilterMemberSubject

type X509AttributeFilterMemberSubject struct {
	Value SubjectFilter
	// contains filtered or unexported fields
}

Filter by certificate subject.

type X509AttributeFilterMemberSubjectAlternativeName

type X509AttributeFilterMemberSubjectAlternativeName struct {
	Value SubjectAlternativeNameFilter
	// contains filtered or unexported fields
}

Filter by subject alternative names.

type X509Attributes

type X509Attributes struct {

	// Contains a list of Extended Key Usage X.509 v3 extension objects. Each object
	// specifies a purpose for which the certificate public key can be used and
	// consists of a name and an object identifier (OID).
	ExtendedKeyUsages []ExtendedKeyUsageName

	// The distinguished name of the certificate issuer.
	Issuer *DistinguishedName

	// The algorithm that was used to generate the public-private key pair.
	KeyAlgorithm KeyAlgorithm

	// A list of Key Usage X.509 v3 extension objects. Each object is a string value
	// that identifies the purpose of the public key contained in the certificate.
	// Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT,
	// NON_REPUDIATION, and more.
	KeyUsages []KeyUsageName

	// The time after which the certificate is not valid.
	NotAfter *time.Time

	// The time before which the certificate is not valid.
	NotBefore *time.Time

	// The serial number assigned by the certificate authority.
	SerialNumber *string

	// The distinguished name of the certificate subject.
	Subject *DistinguishedName

	// One or more domain names (subject alternative names) included in the
	// certificate. This list contains the domain names that are bound to the public
	// key that is contained in the certificate. The subject alternative names include
	// the canonical domain name (CN) of the certificate and additional domain names
	// that can be used to connect to the website.
	SubjectAlternativeNames []GeneralName
	// contains filtered or unexported fields
}

Contains X.509 certificate attributes extracted from the certificate.

Source Files

enums.go errors.go types.go

Version
v1.38.3 (latest)
Published
Apr 29, 2026
Platform
js/wasm
Imports
4 packages
Last checked
now

Tools for package owners.