Documentation
¶
Index ¶
- type AccessDeniedException
- type BadRequestException
- type Challenge
- type ChallengeMetadata
- type ChallengeMetadataSummary
- type ConflictException
- type Connector
- type ConnectorStatus
- type ConnectorStatusReason
- type ConnectorSummary
- type ConnectorType
- type InternalServerException
- type IntuneConfiguration
- type MobileDeviceManagement
- type MobileDeviceManagementMemberIntune
- type OpenIdConfiguration
- type ResourceNotFoundException
- type ServiceQuotaExceededException
- type ThrottlingException
- type UnknownUnionMember
- type ValidationException
- type ValidationExceptionReason
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
You can receive this error if you attempt to perform an operation and you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
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 BadRequestException ¶
type BadRequestException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
func (*BadRequestException) Error ¶
func (e *BadRequestException) Error() string
func (*BadRequestException) ErrorCode ¶
func (e *BadRequestException) ErrorCode() string
func (*BadRequestException) ErrorFault ¶
func (e *BadRequestException) ErrorFault() smithy.ErrorFault
func (*BadRequestException) ErrorMessage ¶
func (e *BadRequestException) ErrorMessage() string
type Challenge ¶
type Challenge struct { // The Amazon Resource Name (ARN) of the challenge. Arn *string // The Amazon Resource Name (ARN) of the connector. ConnectorArn *string // The date and time that the challenge was created. CreatedAt *time.Time // The SCEP challenge password, in UUID format. Password *string // The date and time that the challenge was updated. UpdatedAt *time.Time // contains filtered or unexported fields }
For Connector for SCEP for general-purpose. An object containing information about the specified connector's SCEP challenge passwords.
type ChallengeMetadata ¶
type ChallengeMetadata struct { // The Amazon Resource Name (ARN) of the challenge. Arn *string // The Amazon Resource Name (ARN) of the connector. ConnectorArn *string // The date and time that the connector was created. CreatedAt *time.Time // The date and time that the connector was updated. UpdatedAt *time.Time // contains filtered or unexported fields }
Contains details about the connector's challenge.
type ChallengeMetadataSummary ¶
type ChallengeMetadataSummary struct { // The Amazon Resource Name (ARN) of the challenge. Arn *string // The Amazon Resource Name (ARN) of the connector. ConnectorArn *string // The date and time that the challenge was created. CreatedAt *time.Time // The date and time that the challenge was updated. UpdatedAt *time.Time // contains filtered or unexported fields }
Details about the specified challenge, returned by the GetChallengeMetadata action.
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string ResourceId *string ResourceType *string // contains filtered or unexported fields }
This request can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
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 Connector ¶
type Connector struct { // The Amazon Resource Name (ARN) of the connector. Arn *string // The Amazon Resource Name (ARN) of the certificate authority associated with the // connector. CertificateAuthorityArn *string // The date and time that the connector was created. CreatedAt *time.Time // The connector's HTTPS public SCEP URL. Endpoint *string // Contains settings relevant to the mobile device management system that you // chose for the connector. If you didn't configure MobileDeviceManagement , then // the connector is for general-purpose use and this object is empty. MobileDeviceManagement MobileDeviceManagement // Contains OpenID Connect (OIDC) parameters for use with Connector for SCEP for // Microsoft Intune. For more information about using Connector for SCEP for // Microsoft Intune, see [Using Connector for SCEP for Microsoft Intune]. // // [Using Connector for SCEP for Microsoft Intune]: https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html OpenIdConfiguration *OpenIdConfiguration // The connector's status. Status ConnectorStatus // Information about why connector creation failed, if status is FAILED . StatusReason ConnectorStatusReason // The connector type. Type ConnectorType // The date and time that the connector was updated. UpdatedAt *time.Time // contains filtered or unexported fields }
Connector for SCEP is a service that links Amazon Web Services Private Certificate Authority to your SCEP-enabled devices. The connector brokers the exchange of certificates from Amazon Web Services Private CA to your SCEP-enabled devices and mobile device management systems. The connector is a complex type that contains the connector's configuration settings.
type ConnectorStatus ¶
type ConnectorStatus string
const ( ConnectorStatusCreating ConnectorStatus = "CREATING" ConnectorStatusActive ConnectorStatus = "ACTIVE" ConnectorStatusDeleting ConnectorStatus = "DELETING" ConnectorStatusFailed ConnectorStatus = "FAILED" )
Enum values for ConnectorStatus
func (ConnectorStatus) Values ¶
func (ConnectorStatus) Values() []ConnectorStatus
Values returns all known values for ConnectorStatus. 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 ConnectorStatusReason ¶
type ConnectorStatusReason string
const ( ConnectorStatusReasonInternalFailure ConnectorStatusReason = "INTERNAL_FAILURE" ConnectorStatusReasonPrivatecaAccessDenied ConnectorStatusReason = "PRIVATECA_ACCESS_DENIED" ConnectorStatusReasonPrivatecaInvalidState ConnectorStatusReason = "PRIVATECA_INVALID_STATE" ConnectorStatusReasonPrivatecaResourceNotFound ConnectorStatusReason = "PRIVATECA_RESOURCE_NOT_FOUND" )
Enum values for ConnectorStatusReason
func (ConnectorStatusReason) Values ¶
func (ConnectorStatusReason) Values() []ConnectorStatusReason
Values returns all known values for ConnectorStatusReason. 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 ConnectorSummary ¶
type ConnectorSummary struct { // The Amazon Resource Name (ARN) of the connector. Arn *string // The Amazon Resource Name (ARN) of the connector's associated certificate // authority. CertificateAuthorityArn *string // The date and time that the challenge was created. CreatedAt *time.Time // The connector's HTTPS public SCEP URL. Endpoint *string // Contains settings relevant to the mobile device management system that you // chose for the connector. If you didn't configure MobileDeviceManagement , then // the connector is for general-purpose use and this object is empty. MobileDeviceManagement MobileDeviceManagement // Contains OpenID Connect (OIDC) parameters for use with Microsoft Intune. OpenIdConfiguration *OpenIdConfiguration // The connector's status. Status can be creating, active, deleting, or failed. Status ConnectorStatus // Information about why connector creation failed, if status is FAILED . StatusReason ConnectorStatusReason // The connector type. Type ConnectorType // The date and time that the challenge was updated. UpdatedAt *time.Time // contains filtered or unexported fields }
Lists the Amazon Web Services Private CA SCEP connectors belonging to your Amazon Web Services account.
type ConnectorType ¶
type ConnectorType string
const ( ConnectorTypeGeneralPurpose ConnectorType = "GENERAL_PURPOSE" ConnectorTypeIntune ConnectorType = "INTUNE" )
Enum values for ConnectorType
func (ConnectorType) Values ¶
func (ConnectorType) Values() []ConnectorType
Values returns all known values for ConnectorType. 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 InternalServerException ¶
type InternalServerException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request processing has failed because of an unknown error, exception or failure with an internal server.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type IntuneConfiguration ¶
type IntuneConfiguration struct { // The directory (tenant) ID from your Microsoft Entra ID app registration. // // This member is required. AzureApplicationId *string // The primary domain from your Microsoft Entra ID app registration. // // This member is required. Domain *string // contains filtered or unexported fields }
Contains configuration details for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see Using Connector for SCEP for Microsoft Intune.
When you use Connector for SCEP for Microsoft Intune, certain functionalities are enabled by accessing Microsoft Intune through the Microsoft API. Your use of the Connector for SCEP and accompanying Amazon Web Services services doesn't remove your need to have a valid license for your use of the Microsoft Intune service. You should also review the Microsoft Intune® App Protection Policies.
type MobileDeviceManagement ¶
type MobileDeviceManagement interface {
// contains filtered or unexported methods
}
If you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. For information about considerations and limitations with using Connector for SCEP, see Considerations and Limitations.
If you provide an IntuneConfiguration , Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see Using Connector for SCEP for Microsoft Intune.
The following types satisfy this interface:
MobileDeviceManagementMemberIntune
Example (OutputUsage) ¶
// Code generated by smithy-go-codegen DO NOT EDIT. package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/pcaconnectorscep/types" ) func main() { var union types.MobileDeviceManagement // type switches can be used to check the union value switch v := union.(type) { case *types.MobileDeviceManagementMemberIntune: _ = v.Value // Value is types.IntuneConfiguration case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } } var _ *types.IntuneConfiguration
type MobileDeviceManagementMemberIntune ¶
type MobileDeviceManagementMemberIntune struct { Value IntuneConfiguration // contains filtered or unexported fields }
Configuration settings for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see Using Connector for SCEP for Microsoft Intune.
type OpenIdConfiguration ¶
type OpenIdConfiguration struct { // The audience value to copy into your Microsoft Entra app registration's OIDC. Audience *string // The issuer value to copy into your Microsoft Entra app registration's OIDC. Issuer *string // The subject value to copy into your Microsoft Entra app registration's OIDC. Subject *string // contains filtered or unexported fields }
Contains OpenID Connect (OIDC) parameters for use with Microsoft Intune. For more information about using Connector for SCEP for Microsoft Intune, see Using Connector for SCEP for Microsoft Intune.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string ResourceId *string ResourceType *string // contains filtered or unexported fields }
The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE .
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ErrorCodeOverride *string ResourceType *string ServiceCode *string QuotaCode *string // contains filtered or unexported fields }
The request would cause a service quota to be exceeded.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The limit on the number of requests per second was exceeded.
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 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 Reason ValidationExceptionReason // contains filtered or unexported fields }
An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.
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 ValidationExceptionReason ¶
type ValidationExceptionReason string
const ( ValidationExceptionReasonCaCertValidityTooShort ValidationExceptionReason = "CA_CERT_VALIDITY_TOO_SHORT" ValidationExceptionReasonInvalidCaUsageMode ValidationExceptionReason = "INVALID_CA_USAGE_MODE" ValidationExceptionReasonInvalidConnectorType ValidationExceptionReason = "INVALID_CONNECTOR_TYPE" ValidationExceptionReasonInvalidState ValidationExceptionReason = "INVALID_STATE" ValidationExceptionReasonNoClientToken ValidationExceptionReason = "NO_CLIENT_TOKEN" ValidationExceptionReasonUnknownOperation ValidationExceptionReason = "UNKNOWN_OPERATION" ValidationExceptionReasonOther ValidationExceptionReason = "OTHER" )
Enum values for ValidationExceptionReason
func (ValidationExceptionReason) Values ¶
func (ValidationExceptionReason) Values() []ValidationExceptionReason
Values returns all known values for ValidationExceptionReason. 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.