types

package
v1.2.15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 5, 2025 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

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

	Reason AccessDeniedReason
	// contains filtered or unexported fields
}
You don't have permission to perform the request or access the directory. It

can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

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 AccessDeniedReason

type AccessDeniedReason string
const (
	AccessDeniedReasonIamAuth       AccessDeniedReason = "IAM_AUTH"
	AccessDeniedReasonDirectoryAuth AccessDeniedReason = "DIRECTORY_AUTH"
	AccessDeniedReasonDataDisabled  AccessDeniedReason = "DATA_DISABLED"
)

Enum values for AccessDeniedReason

func (AccessDeniedReason) Values

Values returns all known values for AccessDeniedReason. 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 AttributeValue

type AttributeValue interface {
	// contains filtered or unexported methods
}
The data type for an attribute. Each attribute value is described as a

name-value pair. The name is the AD schema name, and the value is the data itself. For a list of supported attributes, see Directory Service Data Attributes.

The following types satisfy this interface:

AttributeValueMemberBOOL
AttributeValueMemberN
AttributeValueMemberS
AttributeValueMemberSS
Example (OutputUsage)
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

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

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

	case *types.AttributeValueMemberN:
		_ = v.Value // Value is int64

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

	case *types.AttributeValueMemberSS:
		_ = v.Value // Value is []string

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

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

	}
}

var _ []string
var _ *string
var _ *bool
var _ *int64
Output:

type AttributeValueMemberBOOL

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

Indicates that the attribute type value is a boolean. For example:

"BOOL": true

type AttributeValueMemberN

type AttributeValueMemberN struct {
	Value int64
	// contains filtered or unexported fields
}

Indicates that the attribute type value is a number. For example:

"N": "16"

type AttributeValueMemberS

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

Indicates that the attribute type value is a string. For example:

"S": "S Group"

type AttributeValueMemberSS

type AttributeValueMemberSS struct {
	Value []string
	// contains filtered or unexported fields
}

Indicates that the attribute type value is a string set. For example:

"SS": ["sample_service_class/host.sample.com:1234/sample_service_name_1",
"sample_service_class/host.sample.com:1234/sample_service_name_2"]

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}
This error will occur when you try to create a resource that conflicts with an

existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new 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 DirectoryUnavailableException

type DirectoryUnavailableException struct {
	Message *string

	ErrorCodeOverride *string

	Reason DirectoryUnavailableReason
	// contains filtered or unexported fields
}
The request could not be completed due to a problem in the configuration or

current state of the specified directory.

func (*DirectoryUnavailableException) Error

func (*DirectoryUnavailableException) ErrorCode

func (e *DirectoryUnavailableException) ErrorCode() string

func (*DirectoryUnavailableException) ErrorFault

func (*DirectoryUnavailableException) ErrorMessage

func (e *DirectoryUnavailableException) ErrorMessage() string

type DirectoryUnavailableReason

type DirectoryUnavailableReason string
const (
	DirectoryUnavailableReasonInvalidDirectoryState      DirectoryUnavailableReason = "INVALID_DIRECTORY_STATE"
	DirectoryUnavailableReasonDirectoryTimeout           DirectoryUnavailableReason = "DIRECTORY_TIMEOUT"
	DirectoryUnavailableReasonDirectoryResourcesExceeded DirectoryUnavailableReason = "DIRECTORY_RESOURCES_EXCEEDED"
	DirectoryUnavailableReasonNoDiskSpace                DirectoryUnavailableReason = "NO_DISK_SPACE"
	DirectoryUnavailableReasonTrustAuthFailure           DirectoryUnavailableReason = "TRUST_AUTH_FAILURE"
)

Enum values for DirectoryUnavailableReason

func (DirectoryUnavailableReason) Values

Values returns all known values for DirectoryUnavailableReason. 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 Group

type Group struct {

	//  The name of the group.
	//
	// This member is required.
	SAMAccountName *string

	// The [distinguished name] of the object.
	//
	// [distinguished name]: https://learn.microsoft.com/en-us/windows/win32/ad/object-names-and-identities#distinguished-name
	DistinguishedName *string

	//  The scope of the AD group. For details, see [Active Directory security groups]
	//
	// [Active Directory security groups]: https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#group-scope
	GroupScope GroupScope

	//  The AD group type. For details, see [Active Directory security group type].
	//
	// [Active Directory security group type]: https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#how-active-directory-security-groups-work
	GroupType GroupType

	//  An expression of one or more attributes, data types, and the values of a
	// group.
	OtherAttributes map[string]AttributeValue

	//  The unique security identifier (SID) of the group.
	SID *string
	// contains filtered or unexported fields
}
A group object that contains identifying information and attributes for a

specified group.

type GroupScope

type GroupScope string
const (
	GroupScopeDomainLocal  GroupScope = "DomainLocal"
	GroupScopeGlobal       GroupScope = "Global"
	GroupScopeUniversal    GroupScope = "Universal"
	GroupScopeBuiltinLocal GroupScope = "BuiltinLocal"
)

Enum values for GroupScope

func (GroupScope) Values

func (GroupScope) Values() []GroupScope

Values returns all known values for GroupScope. 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 GroupSummary

type GroupSummary struct {

	// The scope of the AD group. For details, see [Active Directory security groups].
	//
	// [Active Directory security groups]: https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#group-scope
	//
	// This member is required.
	GroupScope GroupScope

	// The AD group type. For details, see [Active Directory security group type].
	//
	// [Active Directory security group type]: https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#how-active-directory-security-groups-work
	//
	// This member is required.
	GroupType GroupType

	// The name of the group.
	//
	// This member is required.
	SAMAccountName *string

	// The unique security identifier (SID) of the group.
	//
	// This member is required.
	SID *string
	// contains filtered or unexported fields
}

A structure containing a subset of fields of a group object from a directory.

type GroupType

type GroupType string
const (
	GroupTypeDistribution GroupType = "Distribution"
	GroupTypeSecurity     GroupType = "Security"
)

Enum values for GroupType

func (GroupType) Values

func (GroupType) Values() []GroupType

Values returns all known values for GroupType. 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 operation didn't succeed because an internal error occurred. Try again

later.

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 Member

type Member struct {

	//  The AD type of the member object.
	//
	// This member is required.
	MemberType MemberType

	//  The name of the group member.
	//
	// This member is required.
	SAMAccountName *string

	//  The unique security identifier (SID) of the group member.
	//
	// This member is required.
	SID *string
	// contains filtered or unexported fields
}

A member object that contains identifying information for a specified member.

type MemberType

type MemberType string
const (
	MemberTypeUser     MemberType = "USER"
	MemberTypeGroup    MemberType = "GROUP"
	MemberTypeComputer MemberType = "COMPUTER"
)

Enum values for MemberType

func (MemberType) Values

func (MemberType) Values() []MemberType

Values returns all known values for MemberType. 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 ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource couldn't 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 ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

The limit on the number of requests per second has been 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 UpdateType

type UpdateType string
const (
	UpdateTypeAdd     UpdateType = "ADD"
	UpdateTypeReplace UpdateType = "REPLACE"
	UpdateTypeRemove  UpdateType = "REMOVE"
)

Enum values for UpdateType

func (UpdateType) Values

func (UpdateType) Values() []UpdateType

Values returns all known values for UpdateType. 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 User

type User struct {

	//  The name of the user.
	//
	// This member is required.
	SAMAccountName *string

	//  The [distinguished name] of the object.
	//
	// [distinguished name]: https://learn.microsoft.com/en-us/windows/win32/ad/object-names-and-identities#distinguished-name
	DistinguishedName *string

	//  The email address of the user.
	EmailAddress *string

	//  Indicates whether the user account is active.
	Enabled *bool

	//  The first name of the user.
	GivenName *string

	//  An expression that includes one or more attributes, data types, and values of
	// a user.
	OtherAttributes map[string]AttributeValue

	//  The unique security identifier (SID) of the user.
	SID *string

	//  The last name of the user.
	Surname *string

	//  The UPN that is an internet-style login name for a user and based on the
	// internet standard [RFC 822]. The UPN is shorter than the distinguished name and easier
	// to remember.
	//
	// [RFC 822]: https://www.ietf.org/rfc/rfc0822.txt
	UserPrincipalName *string
	// contains filtered or unexported fields
}
A user object that contains identifying information and attributes for a

specified user.

type UserSummary

type UserSummary struct {

	// Indicates whether the user account is active.
	//
	// This member is required.
	Enabled *bool

	// The name of the user.
	//
	// This member is required.
	SAMAccountName *string

	//  The unique security identifier (SID) of the user.
	//
	// This member is required.
	SID *string

	// The first name of the user.
	GivenName *string

	// The last name of the user.
	Surname *string
	// contains filtered or unexported fields
}

A structure containing a subset of the fields of a user object from a directory.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	// contains filtered or unexported fields
}
The request isn't valid. Review the details in the error message to update the

invalid parameters or values in your request.

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 (
	ValidationExceptionReasonInvalidRealm              ValidationExceptionReason = "INVALID_REALM"
	ValidationExceptionReasonInvalidDirectoryType      ValidationExceptionReason = "INVALID_DIRECTORY_TYPE"
	ValidationExceptionReasonInvalidSecondaryRegion    ValidationExceptionReason = "INVALID_SECONDARY_REGION"
	ValidationExceptionReasonInvalidNextToken          ValidationExceptionReason = "INVALID_NEXT_TOKEN"
	ValidationExceptionReasonInvalidAttributeValue     ValidationExceptionReason = "INVALID_ATTRIBUTE_VALUE"
	ValidationExceptionReasonInvalidAttributeName      ValidationExceptionReason = "INVALID_ATTRIBUTE_NAME"
	ValidationExceptionReasonInvalidAttributeForUser   ValidationExceptionReason = "INVALID_ATTRIBUTE_FOR_USER"
	ValidationExceptionReasonInvalidAttributeForGroup  ValidationExceptionReason = "INVALID_ATTRIBUTE_FOR_GROUP"
	ValidationExceptionReasonInvalidAttributeForSearch ValidationExceptionReason = "INVALID_ATTRIBUTE_FOR_SEARCH"
	ValidationExceptionReasonInvalidAttributeForModify ValidationExceptionReason = "INVALID_ATTRIBUTE_FOR_MODIFY"
	ValidationExceptionReasonDuplicateAttribute        ValidationExceptionReason = "DUPLICATE_ATTRIBUTE"
	ValidationExceptionReasonMissingAttribute          ValidationExceptionReason = "MISSING_ATTRIBUTE"
	ValidationExceptionReasonAttributeExists           ValidationExceptionReason = "ATTRIBUTE_EXISTS"
	ValidationExceptionReasonLdapSizeLimitExceeded     ValidationExceptionReason = "LDAP_SIZE_LIMIT_EXCEEDED"
	ValidationExceptionReasonLdapUnsupportedOperation  ValidationExceptionReason = "LDAP_UNSUPPORTED_OPERATION"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL