directoryservice

package
v1.14.3 Latest Latest
Warning

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

Go to latest
Published: Jun 8, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package directoryservice provides the client and types for making API requests to AWS Directory Service.

AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service (https://aws.amazon.com/directoryservice/) and the AWS Directory Service Administration Guide (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html).

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/).

See https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16 for more information on this service.

See directoryservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/directoryservice/

Using the Client

To contact AWS Directory Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Directory Service client DirectoryService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/directoryservice/#New

Index

Constants

View Source
const (
	// DirectoryEditionEnterprise is a DirectoryEdition enum value
	DirectoryEditionEnterprise = "Enterprise"

	// DirectoryEditionStandard is a DirectoryEdition enum value
	DirectoryEditionStandard = "Standard"
)
View Source
const (
	// DirectorySizeSmall is a DirectorySize enum value
	DirectorySizeSmall = "Small"

	// DirectorySizeLarge is a DirectorySize enum value
	DirectorySizeLarge = "Large"
)
View Source
const (
	// DirectoryStageRequested is a DirectoryStage enum value
	DirectoryStageRequested = "Requested"

	// DirectoryStageCreating is a DirectoryStage enum value
	DirectoryStageCreating = "Creating"

	// DirectoryStageCreated is a DirectoryStage enum value
	DirectoryStageCreated = "Created"

	// DirectoryStageActive is a DirectoryStage enum value
	DirectoryStageActive = "Active"

	// DirectoryStageInoperable is a DirectoryStage enum value
	DirectoryStageInoperable = "Inoperable"

	// DirectoryStageImpaired is a DirectoryStage enum value
	DirectoryStageImpaired = "Impaired"

	// DirectoryStageRestoring is a DirectoryStage enum value
	DirectoryStageRestoring = "Restoring"

	// DirectoryStageRestoreFailed is a DirectoryStage enum value
	DirectoryStageRestoreFailed = "RestoreFailed"

	// DirectoryStageDeleting is a DirectoryStage enum value
	DirectoryStageDeleting = "Deleting"

	// DirectoryStageDeleted is a DirectoryStage enum value
	DirectoryStageDeleted = "Deleted"

	// DirectoryStageFailed is a DirectoryStage enum value
	DirectoryStageFailed = "Failed"
)
View Source
const (
	// DirectoryTypeSimpleAd is a DirectoryType enum value
	DirectoryTypeSimpleAd = "SimpleAD"

	// DirectoryTypeAdconnector is a DirectoryType enum value
	DirectoryTypeAdconnector = "ADConnector"

	// DirectoryTypeMicrosoftAd is a DirectoryType enum value
	DirectoryTypeMicrosoftAd = "MicrosoftAD"
)
View Source
const (
	// DomainControllerStatusCreating is a DomainControllerStatus enum value
	DomainControllerStatusCreating = "Creating"

	// DomainControllerStatusActive is a DomainControllerStatus enum value
	DomainControllerStatusActive = "Active"

	// DomainControllerStatusImpaired is a DomainControllerStatus enum value
	DomainControllerStatusImpaired = "Impaired"

	// DomainControllerStatusRestoring is a DomainControllerStatus enum value
	DomainControllerStatusRestoring = "Restoring"

	// DomainControllerStatusDeleting is a DomainControllerStatus enum value
	DomainControllerStatusDeleting = "Deleting"

	// DomainControllerStatusDeleted is a DomainControllerStatus enum value
	DomainControllerStatusDeleted = "Deleted"

	// DomainControllerStatusFailed is a DomainControllerStatus enum value
	DomainControllerStatusFailed = "Failed"
)
View Source
const (
	// IpRouteStatusMsgAdding is a IpRouteStatusMsg enum value
	IpRouteStatusMsgAdding = "Adding"

	// IpRouteStatusMsgAdded is a IpRouteStatusMsg enum value
	IpRouteStatusMsgAdded = "Added"

	// IpRouteStatusMsgRemoving is a IpRouteStatusMsg enum value
	IpRouteStatusMsgRemoving = "Removing"

	// IpRouteStatusMsgRemoved is a IpRouteStatusMsg enum value
	IpRouteStatusMsgRemoved = "Removed"

	// IpRouteStatusMsgAddFailed is a IpRouteStatusMsg enum value
	IpRouteStatusMsgAddFailed = "AddFailed"

	// IpRouteStatusMsgRemoveFailed is a IpRouteStatusMsg enum value
	IpRouteStatusMsgRemoveFailed = "RemoveFailed"
)
View Source
const (
	// RadiusAuthenticationProtocolPap is a RadiusAuthenticationProtocol enum value
	RadiusAuthenticationProtocolPap = "PAP"

	// RadiusAuthenticationProtocolChap is a RadiusAuthenticationProtocol enum value
	RadiusAuthenticationProtocolChap = "CHAP"

	// RadiusAuthenticationProtocolMsChapv1 is a RadiusAuthenticationProtocol enum value
	RadiusAuthenticationProtocolMsChapv1 = "MS-CHAPv1"

	// RadiusAuthenticationProtocolMsChapv2 is a RadiusAuthenticationProtocol enum value
	RadiusAuthenticationProtocolMsChapv2 = "MS-CHAPv2"
)
View Source
const (
	// RadiusStatusCreating is a RadiusStatus enum value
	RadiusStatusCreating = "Creating"

	// RadiusStatusCompleted is a RadiusStatus enum value
	RadiusStatusCompleted = "Completed"

	// RadiusStatusFailed is a RadiusStatus enum value
	RadiusStatusFailed = "Failed"
)
View Source
const (
	// SchemaExtensionStatusInitializing is a SchemaExtensionStatus enum value
	SchemaExtensionStatusInitializing = "Initializing"

	// SchemaExtensionStatusCreatingSnapshot is a SchemaExtensionStatus enum value
	SchemaExtensionStatusCreatingSnapshot = "CreatingSnapshot"

	// SchemaExtensionStatusUpdatingSchema is a SchemaExtensionStatus enum value
	SchemaExtensionStatusUpdatingSchema = "UpdatingSchema"

	// SchemaExtensionStatusReplicating is a SchemaExtensionStatus enum value
	SchemaExtensionStatusReplicating = "Replicating"

	// SchemaExtensionStatusCancelInProgress is a SchemaExtensionStatus enum value
	SchemaExtensionStatusCancelInProgress = "CancelInProgress"

	// SchemaExtensionStatusRollbackInProgress is a SchemaExtensionStatus enum value
	SchemaExtensionStatusRollbackInProgress = "RollbackInProgress"

	// SchemaExtensionStatusCancelled is a SchemaExtensionStatus enum value
	SchemaExtensionStatusCancelled = "Cancelled"

	// SchemaExtensionStatusFailed is a SchemaExtensionStatus enum value
	SchemaExtensionStatusFailed = "Failed"

	// SchemaExtensionStatusCompleted is a SchemaExtensionStatus enum value
	SchemaExtensionStatusCompleted = "Completed"
)
View Source
const (
	// SnapshotStatusCreating is a SnapshotStatus enum value
	SnapshotStatusCreating = "Creating"

	// SnapshotStatusCompleted is a SnapshotStatus enum value
	SnapshotStatusCompleted = "Completed"

	// SnapshotStatusFailed is a SnapshotStatus enum value
	SnapshotStatusFailed = "Failed"
)
View Source
const (
	// SnapshotTypeAuto is a SnapshotType enum value
	SnapshotTypeAuto = "Auto"

	// SnapshotTypeManual is a SnapshotType enum value
	SnapshotTypeManual = "Manual"
)
View Source
const (
	// TopicStatusRegistered is a TopicStatus enum value
	TopicStatusRegistered = "Registered"

	// TopicStatusTopicnotfound is a TopicStatus enum value
	TopicStatusTopicnotfound = "Topic not found"

	// TopicStatusFailed is a TopicStatus enum value
	TopicStatusFailed = "Failed"

	// TopicStatusDeleted is a TopicStatus enum value
	TopicStatusDeleted = "Deleted"
)
View Source
const (
	// TrustDirectionOneWayOutgoing is a TrustDirection enum value
	TrustDirectionOneWayOutgoing = "One-Way: Outgoing"

	// TrustDirectionOneWayIncoming is a TrustDirection enum value
	TrustDirectionOneWayIncoming = "One-Way: Incoming"

	// TrustDirectionTwoWay is a TrustDirection enum value
	TrustDirectionTwoWay = "Two-Way"
)
View Source
const (
	// TrustStateCreating is a TrustState enum value
	TrustStateCreating = "Creating"

	// TrustStateCreated is a TrustState enum value
	TrustStateCreated = "Created"

	// TrustStateVerifying is a TrustState enum value
	TrustStateVerifying = "Verifying"

	// TrustStateVerifyFailed is a TrustState enum value
	TrustStateVerifyFailed = "VerifyFailed"

	// TrustStateVerified is a TrustState enum value
	TrustStateVerified = "Verified"

	// TrustStateDeleting is a TrustState enum value
	TrustStateDeleting = "Deleting"

	// TrustStateDeleted is a TrustState enum value
	TrustStateDeleted = "Deleted"

	// TrustStateFailed is a TrustState enum value
	TrustStateFailed = "Failed"
)
View Source
const (

	// ErrCodeAuthenticationFailedException for service response error code
	// "AuthenticationFailedException".
	//
	// An authentication error occurred.
	ErrCodeAuthenticationFailedException = "AuthenticationFailedException"

	// ErrCodeClientException for service response error code
	// "ClientException".
	//
	// A client exception has occurred.
	ErrCodeClientException = "ClientException"

	// ErrCodeDirectoryLimitExceededException for service response error code
	// "DirectoryLimitExceededException".
	//
	// The maximum number of directories in the region has been reached. You can
	// use the GetDirectoryLimits operation to determine your directory limits in
	// the region.
	ErrCodeDirectoryLimitExceededException = "DirectoryLimitExceededException"

	// ErrCodeDirectoryUnavailableException for service response error code
	// "DirectoryUnavailableException".
	//
	// The specified directory is unavailable or could not be found.
	ErrCodeDirectoryUnavailableException = "DirectoryUnavailableException"

	// ErrCodeDomainControllerLimitExceededException for service response error code
	// "DomainControllerLimitExceededException".
	//
	// The maximum allowed number of domain controllers per directory was exceeded.
	// The default limit per directory is 20 domain controllers.
	ErrCodeDomainControllerLimitExceededException = "DomainControllerLimitExceededException"

	// ErrCodeEntityAlreadyExistsException for service response error code
	// "EntityAlreadyExistsException".
	//
	// The specified entity already exists.
	ErrCodeEntityAlreadyExistsException = "EntityAlreadyExistsException"

	// ErrCodeEntityDoesNotExistException for service response error code
	// "EntityDoesNotExistException".
	//
	// The specified entity could not be found.
	ErrCodeEntityDoesNotExistException = "EntityDoesNotExistException"

	// ErrCodeInsufficientPermissionsException for service response error code
	// "InsufficientPermissionsException".
	//
	// The account does not have sufficient permission to perform the operation.
	ErrCodeInsufficientPermissionsException = "InsufficientPermissionsException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The NextToken value is not valid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// One or more parameters are not valid.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidPasswordException for service response error code
	// "InvalidPasswordException".
	//
	// The new password provided by the user does not meet the password complexity
	// requirements defined in your directory.
	ErrCodeInvalidPasswordException = "InvalidPasswordException"

	// ErrCodeIpRouteLimitExceededException for service response error code
	// "IpRouteLimitExceededException".
	//
	// The maximum allowed number of IP addresses was exceeded. The default limit
	// is 100 IP address blocks.
	ErrCodeIpRouteLimitExceededException = "IpRouteLimitExceededException"

	// ErrCodeServiceException for service response error code
	// "ServiceException".
	//
	// An exception has occurred in AWS Directory Service.
	ErrCodeServiceException = "ServiceException"

	// ErrCodeSnapshotLimitExceededException for service response error code
	// "SnapshotLimitExceededException".
	//
	// The maximum number of manual snapshots for the directory has been reached.
	// You can use the GetSnapshotLimits operation to determine the snapshot limits
	// for a directory.
	ErrCodeSnapshotLimitExceededException = "SnapshotLimitExceededException"

	// ErrCodeTagLimitExceededException for service response error code
	// "TagLimitExceededException".
	//
	// The maximum allowed number of tags was exceeded.
	ErrCodeTagLimitExceededException = "TagLimitExceededException"

	// ErrCodeUnsupportedOperationException for service response error code
	// "UnsupportedOperationException".
	//
	// The operation is not supported.
	ErrCodeUnsupportedOperationException = "UnsupportedOperationException"

	// ErrCodeUserDoesNotExistException for service response error code
	// "UserDoesNotExistException".
	//
	// The user provided a username that does not exist in your directory.
	ErrCodeUserDoesNotExistException = "UserDoesNotExistException"
)
View Source
const (
	ServiceName = "ds"                // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName         // Service ID for Regions and Endpoints metadata.
	ServiceID   = "Directory Service" // ServiceID is a unique identifer of a specific service
)

Service information constants

View Source
const (
	// ReplicationScopeDomain is a ReplicationScope enum value
	ReplicationScopeDomain = "Domain"
)
View Source
const (
	// TrustTypeForest is a TrustType enum value
	TrustTypeForest = "Forest"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddIpRoutesInput added in v1.2.10

type AddIpRoutesInput struct {

	// Identifier (ID) of the directory to which to add the address block.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// IP address blocks, using CIDR format, of the traffic to route. This is often
	// the IP address block of the DNS server used for your on-premises domain.
	//
	// IpRoutes is a required field
	IpRoutes []*IpRoute `type:"list" required:"true"`

	// If set to true, updates the inbound and outbound rules of the security group
	// that has the description: "AWS created security group for directory ID directory
	// controllers." Following are the new rules:
	//
	// Inbound:
	//
	//    * Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0
	//
	//    * Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0
	//
	//    * Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0
	//
	//    * Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0
	//
	//    * Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0
	//
	//    * Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0
	//
	//    * Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0
	//
	//    * Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0
	//
	//    * Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0
	//
	//    * Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0
	//
	//    * Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0
	//
	//    * Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
	//
	//    * Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
	//
	//    * Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
	//
	//    * Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0
	//
	//    * Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0
	//
	//    * Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0
	//
	// Outbound:
	//
	// Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0
	UpdateSecurityGroupForDirectoryControllers *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (AddIpRoutesInput) GoString added in v1.2.10

func (s AddIpRoutesInput) GoString() string

GoString returns the string representation

func (*AddIpRoutesInput) SetDirectoryId added in v1.5.0

func (s *AddIpRoutesInput) SetDirectoryId(v string) *AddIpRoutesInput

SetDirectoryId sets the DirectoryId field's value.

func (*AddIpRoutesInput) SetIpRoutes added in v1.5.0

func (s *AddIpRoutesInput) SetIpRoutes(v []*IpRoute) *AddIpRoutesInput

SetIpRoutes sets the IpRoutes field's value.

func (*AddIpRoutesInput) SetUpdateSecurityGroupForDirectoryControllers added in v1.5.0

func (s *AddIpRoutesInput) SetUpdateSecurityGroupForDirectoryControllers(v bool) *AddIpRoutesInput

SetUpdateSecurityGroupForDirectoryControllers sets the UpdateSecurityGroupForDirectoryControllers field's value.

func (AddIpRoutesInput) String added in v1.2.10

func (s AddIpRoutesInput) String() string

String returns the string representation

func (*AddIpRoutesInput) Validate added in v1.2.10

func (s *AddIpRoutesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddIpRoutesOutput added in v1.2.10

type AddIpRoutesOutput struct {
	// contains filtered or unexported fields
}

func (AddIpRoutesOutput) GoString added in v1.2.10

func (s AddIpRoutesOutput) GoString() string

GoString returns the string representation

func (AddIpRoutesOutput) String added in v1.2.10

func (s AddIpRoutesOutput) String() string

String returns the string representation

type AddTagsToResourceInput added in v1.2.4

type AddTagsToResourceInput struct {

	// Identifier (ID) for the directory to which to add the tag.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// The tags to be assigned to the directory.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AddTagsToResourceInput) GoString added in v1.2.4

func (s AddTagsToResourceInput) GoString() string

GoString returns the string representation

func (*AddTagsToResourceInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*AddTagsToResourceInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (AddTagsToResourceInput) String added in v1.2.4

func (s AddTagsToResourceInput) String() string

String returns the string representation

func (*AddTagsToResourceInput) Validate added in v1.2.4

func (s *AddTagsToResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddTagsToResourceOutput added in v1.2.4

type AddTagsToResourceOutput struct {
	// contains filtered or unexported fields
}

func (AddTagsToResourceOutput) GoString added in v1.2.4

func (s AddTagsToResourceOutput) GoString() string

GoString returns the string representation

func (AddTagsToResourceOutput) String added in v1.2.4

func (s AddTagsToResourceOutput) String() string

String returns the string representation

type Attribute

type Attribute struct {

	// The name of the attribute.
	Name *string `min:"1" type:"string"`

	// The value of the attribute.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a named directory attribute.

func (Attribute) GoString added in v0.6.5

func (s Attribute) GoString() string

GoString returns the string representation

func (*Attribute) SetName added in v1.5.0

func (s *Attribute) SetName(v string) *Attribute

SetName sets the Name field's value.

func (*Attribute) SetValue added in v1.5.0

func (s *Attribute) SetValue(v string) *Attribute

SetValue sets the Value field's value.

func (Attribute) String added in v0.6.5

func (s Attribute) String() string

String returns the string representation

func (*Attribute) Validate added in v1.1.21

func (s *Attribute) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelSchemaExtensionInput added in v1.5.5

type CancelSchemaExtensionInput struct {

	// The identifier of the directory whose schema extension will be canceled.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The identifier of the schema extension that will be canceled.
	//
	// SchemaExtensionId is a required field
	SchemaExtensionId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelSchemaExtensionInput) GoString added in v1.5.5

func (s CancelSchemaExtensionInput) GoString() string

GoString returns the string representation

func (*CancelSchemaExtensionInput) SetDirectoryId added in v1.5.5

SetDirectoryId sets the DirectoryId field's value.

func (*CancelSchemaExtensionInput) SetSchemaExtensionId added in v1.5.5

func (s *CancelSchemaExtensionInput) SetSchemaExtensionId(v string) *CancelSchemaExtensionInput

SetSchemaExtensionId sets the SchemaExtensionId field's value.

func (CancelSchemaExtensionInput) String added in v1.5.5

String returns the string representation

func (*CancelSchemaExtensionInput) Validate added in v1.5.5

func (s *CancelSchemaExtensionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelSchemaExtensionOutput added in v1.5.5

type CancelSchemaExtensionOutput struct {
	// contains filtered or unexported fields
}

func (CancelSchemaExtensionOutput) GoString added in v1.5.5

func (s CancelSchemaExtensionOutput) GoString() string

GoString returns the string representation

func (CancelSchemaExtensionOutput) String added in v1.5.5

String returns the string representation

type Computer

type Computer struct {

	// An array of Attribute objects containing the LDAP attributes that belong
	// to the computer account.
	ComputerAttributes []*Attribute `type:"list"`

	// The identifier of the computer.
	ComputerId *string `min:"1" type:"string"`

	// The computer name.
	ComputerName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about a computer account in a directory.

func (Computer) GoString added in v0.6.5

func (s Computer) GoString() string

GoString returns the string representation

func (*Computer) SetComputerAttributes added in v1.5.0

func (s *Computer) SetComputerAttributes(v []*Attribute) *Computer

SetComputerAttributes sets the ComputerAttributes field's value.

func (*Computer) SetComputerId added in v1.5.0

func (s *Computer) SetComputerId(v string) *Computer

SetComputerId sets the ComputerId field's value.

func (*Computer) SetComputerName added in v1.5.0

func (s *Computer) SetComputerName(v string) *Computer

SetComputerName sets the ComputerName field's value.

func (Computer) String added in v0.6.5

func (s Computer) String() string

String returns the string representation

type ConditionalForwarder added in v1.1.17

type ConditionalForwarder struct {

	// The IP addresses of the remote DNS server associated with RemoteDomainName.
	// This is the IP address of the DNS server that your conditional forwarder
	// points to.
	DnsIpAddrs []*string `type:"list"`

	// The fully qualified domain name (FQDN) of the remote domains pointed to by
	// the conditional forwarder.
	RemoteDomainName *string `type:"string"`

	// The replication scope of the conditional forwarder. The only allowed value
	// is Domain, which will replicate the conditional forwarder to all of the domain
	// controllers for your AWS directory.
	ReplicationScope *string `type:"string" enum:"ReplicationScope"`
	// contains filtered or unexported fields
}

Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain.

func (ConditionalForwarder) GoString added in v1.1.17

func (s ConditionalForwarder) GoString() string

GoString returns the string representation

func (*ConditionalForwarder) SetDnsIpAddrs added in v1.5.0

func (s *ConditionalForwarder) SetDnsIpAddrs(v []*string) *ConditionalForwarder

SetDnsIpAddrs sets the DnsIpAddrs field's value.

func (*ConditionalForwarder) SetRemoteDomainName added in v1.5.0

func (s *ConditionalForwarder) SetRemoteDomainName(v string) *ConditionalForwarder

SetRemoteDomainName sets the RemoteDomainName field's value.

func (*ConditionalForwarder) SetReplicationScope added in v1.5.0

func (s *ConditionalForwarder) SetReplicationScope(v string) *ConditionalForwarder

SetReplicationScope sets the ReplicationScope field's value.

func (ConditionalForwarder) String added in v1.1.17

func (s ConditionalForwarder) String() string

String returns the string representation

type ConnectDirectoryInput

type ConnectDirectoryInput struct {

	// A DirectoryConnectSettings object that contains additional information for
	// the operation.
	//
	// ConnectSettings is a required field
	ConnectSettings *DirectoryConnectSettings `type:"structure" required:"true"`

	// A textual description for the directory.
	Description *string `type:"string"`

	// The fully-qualified name of the on-premises directory, such as corp.example.com.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The password for the on-premises user account.
	//
	// Password is a required field
	Password *string `min:"1" type:"string" required:"true"`

	// The NetBIOS name of the on-premises directory, such as CORP.
	ShortName *string `type:"string"`

	// The size of the directory.
	//
	// Size is a required field
	Size *string `type:"string" required:"true" enum:"DirectorySize"`
	// contains filtered or unexported fields
}

Contains the inputs for the ConnectDirectory operation.

func (ConnectDirectoryInput) GoString added in v0.6.5

func (s ConnectDirectoryInput) GoString() string

GoString returns the string representation

func (*ConnectDirectoryInput) SetConnectSettings added in v1.5.0

SetConnectSettings sets the ConnectSettings field's value.

func (*ConnectDirectoryInput) SetDescription added in v1.5.0

func (s *ConnectDirectoryInput) SetDescription(v string) *ConnectDirectoryInput

SetDescription sets the Description field's value.

func (*ConnectDirectoryInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*ConnectDirectoryInput) SetPassword added in v1.5.0

SetPassword sets the Password field's value.

func (*ConnectDirectoryInput) SetShortName added in v1.5.0

SetShortName sets the ShortName field's value.

func (*ConnectDirectoryInput) SetSize added in v1.5.0

SetSize sets the Size field's value.

func (ConnectDirectoryInput) String added in v0.6.5

func (s ConnectDirectoryInput) String() string

String returns the string representation

func (*ConnectDirectoryInput) Validate added in v1.1.21

func (s *ConnectDirectoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConnectDirectoryOutput

type ConnectDirectoryOutput struct {

	// The identifier of the new directory.
	DirectoryId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of the ConnectDirectory operation.

func (ConnectDirectoryOutput) GoString added in v0.6.5

func (s ConnectDirectoryOutput) GoString() string

GoString returns the string representation

func (*ConnectDirectoryOutput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (ConnectDirectoryOutput) String added in v0.6.5

func (s ConnectDirectoryOutput) String() string

String returns the string representation

type CreateAliasInput

type CreateAliasInput struct {

	// The requested alias.
	//
	// The alias must be unique amongst all aliases in AWS. This operation throws
	// an EntityAlreadyExistsException error if the alias already exists.
	//
	// Alias is a required field
	Alias *string `min:"1" type:"string" required:"true"`

	// The identifier of the directory for which to create the alias.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the CreateAlias operation.

func (CreateAliasInput) GoString added in v0.6.5

func (s CreateAliasInput) GoString() string

GoString returns the string representation

func (*CreateAliasInput) SetAlias added in v1.5.0

func (s *CreateAliasInput) SetAlias(v string) *CreateAliasInput

SetAlias sets the Alias field's value.

func (*CreateAliasInput) SetDirectoryId added in v1.5.0

func (s *CreateAliasInput) SetDirectoryId(v string) *CreateAliasInput

SetDirectoryId sets the DirectoryId field's value.

func (CreateAliasInput) String added in v0.6.5

func (s CreateAliasInput) String() string

String returns the string representation

func (*CreateAliasInput) Validate added in v1.1.21

func (s *CreateAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAliasOutput

type CreateAliasOutput struct {

	// The alias for the directory.
	Alias *string `min:"1" type:"string"`

	// The identifier of the directory.
	DirectoryId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of the CreateAlias operation.

func (CreateAliasOutput) GoString added in v0.6.5

func (s CreateAliasOutput) GoString() string

GoString returns the string representation

func (*CreateAliasOutput) SetAlias added in v1.5.0

func (s *CreateAliasOutput) SetAlias(v string) *CreateAliasOutput

SetAlias sets the Alias field's value.

func (*CreateAliasOutput) SetDirectoryId added in v1.5.0

func (s *CreateAliasOutput) SetDirectoryId(v string) *CreateAliasOutput

SetDirectoryId sets the DirectoryId field's value.

func (CreateAliasOutput) String added in v0.6.5

func (s CreateAliasOutput) String() string

String returns the string representation

type CreateComputerInput

type CreateComputerInput struct {

	// An array of Attribute objects that contain any LDAP attributes to apply to
	// the computer account.
	ComputerAttributes []*Attribute `type:"list"`

	// The name of the computer account.
	//
	// ComputerName is a required field
	ComputerName *string `min:"1" type:"string" required:"true"`

	// The identifier of the directory in which to create the computer account.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The fully-qualified distinguished name of the organizational unit to place
	// the computer account in.
	OrganizationalUnitDistinguishedName *string `min:"1" type:"string"`

	// A one-time password that is used to join the computer to the directory. You
	// should generate a random, strong password to use for this parameter.
	//
	// Password is a required field
	Password *string `min:"8" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the CreateComputer operation.

func (CreateComputerInput) GoString added in v0.6.5

func (s CreateComputerInput) GoString() string

GoString returns the string representation

func (*CreateComputerInput) SetComputerAttributes added in v1.5.0

func (s *CreateComputerInput) SetComputerAttributes(v []*Attribute) *CreateComputerInput

SetComputerAttributes sets the ComputerAttributes field's value.

func (*CreateComputerInput) SetComputerName added in v1.5.0

func (s *CreateComputerInput) SetComputerName(v string) *CreateComputerInput

SetComputerName sets the ComputerName field's value.

func (*CreateComputerInput) SetDirectoryId added in v1.5.0

func (s *CreateComputerInput) SetDirectoryId(v string) *CreateComputerInput

SetDirectoryId sets the DirectoryId field's value.

func (*CreateComputerInput) SetOrganizationalUnitDistinguishedName added in v1.5.0

func (s *CreateComputerInput) SetOrganizationalUnitDistinguishedName(v string) *CreateComputerInput

SetOrganizationalUnitDistinguishedName sets the OrganizationalUnitDistinguishedName field's value.

func (*CreateComputerInput) SetPassword added in v1.5.0

func (s *CreateComputerInput) SetPassword(v string) *CreateComputerInput

SetPassword sets the Password field's value.

func (CreateComputerInput) String added in v0.6.5

func (s CreateComputerInput) String() string

String returns the string representation

func (*CreateComputerInput) Validate added in v1.1.21

func (s *CreateComputerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateComputerOutput

type CreateComputerOutput struct {

	// A Computer object that represents the computer account.
	Computer *Computer `type:"structure"`
	// contains filtered or unexported fields
}

Contains the results for the CreateComputer operation.

func (CreateComputerOutput) GoString added in v0.6.5

func (s CreateComputerOutput) GoString() string

GoString returns the string representation

func (*CreateComputerOutput) SetComputer added in v1.5.0

SetComputer sets the Computer field's value.

func (CreateComputerOutput) String added in v0.6.5

func (s CreateComputerOutput) String() string

String returns the string representation

type CreateConditionalForwarderInput added in v1.1.17

type CreateConditionalForwarderInput struct {

	// The directory ID of the AWS directory for which you are creating the conditional
	// forwarder.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The IP addresses of the remote DNS server associated with RemoteDomainName.
	//
	// DnsIpAddrs is a required field
	DnsIpAddrs []*string `type:"list" required:"true"`

	// The fully qualified domain name (FQDN) of the remote domain with which you
	// will set up a trust relationship.
	//
	// RemoteDomainName is a required field
	RemoteDomainName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.

func (CreateConditionalForwarderInput) GoString added in v1.1.17

GoString returns the string representation

func (*CreateConditionalForwarderInput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (*CreateConditionalForwarderInput) SetDnsIpAddrs added in v1.5.0

SetDnsIpAddrs sets the DnsIpAddrs field's value.

func (*CreateConditionalForwarderInput) SetRemoteDomainName added in v1.5.0

SetRemoteDomainName sets the RemoteDomainName field's value.

func (CreateConditionalForwarderInput) String added in v1.1.17

String returns the string representation

func (*CreateConditionalForwarderInput) Validate added in v1.1.21

func (s *CreateConditionalForwarderInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConditionalForwarderOutput added in v1.1.17

type CreateConditionalForwarderOutput struct {
	// contains filtered or unexported fields
}

The result of a CreateConditinalForwarder request.

func (CreateConditionalForwarderOutput) GoString added in v1.1.17

GoString returns the string representation

func (CreateConditionalForwarderOutput) String added in v1.1.17

String returns the string representation

type CreateDirectoryInput

type CreateDirectoryInput struct {

	// A textual description for the directory.
	Description *string `type:"string"`

	// The fully qualified name for the directory, such as corp.example.com.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The password for the directory administrator. The directory creation process
	// creates a directory administrator account with the username Administrator
	// and this password.
	//
	// Password is a required field
	Password *string `type:"string" required:"true"`

	// The short name of the directory, such as CORP.
	ShortName *string `type:"string"`

	// The size of the directory.
	//
	// Size is a required field
	Size *string `type:"string" required:"true" enum:"DirectorySize"`

	// A DirectoryVpcSettings object that contains additional information for the
	// operation.
	VpcSettings *DirectoryVpcSettings `type:"structure"`
	// contains filtered or unexported fields
}

Contains the inputs for the CreateDirectory operation.

func (CreateDirectoryInput) GoString added in v0.6.5

func (s CreateDirectoryInput) GoString() string

GoString returns the string representation

func (*CreateDirectoryInput) SetDescription added in v1.5.0

func (s *CreateDirectoryInput) SetDescription(v string) *CreateDirectoryInput

SetDescription sets the Description field's value.

func (*CreateDirectoryInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*CreateDirectoryInput) SetPassword added in v1.5.0

SetPassword sets the Password field's value.

func (*CreateDirectoryInput) SetShortName added in v1.5.0

func (s *CreateDirectoryInput) SetShortName(v string) *CreateDirectoryInput

SetShortName sets the ShortName field's value.

func (*CreateDirectoryInput) SetSize added in v1.5.0

SetSize sets the Size field's value.

func (*CreateDirectoryInput) SetVpcSettings added in v1.5.0

SetVpcSettings sets the VpcSettings field's value.

func (CreateDirectoryInput) String added in v0.6.5

func (s CreateDirectoryInput) String() string

String returns the string representation

func (*CreateDirectoryInput) Validate added in v1.1.21

func (s *CreateDirectoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDirectoryOutput

type CreateDirectoryOutput struct {

	// The identifier of the directory that was created.
	DirectoryId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of the CreateDirectory operation.

func (CreateDirectoryOutput) GoString added in v0.6.5

func (s CreateDirectoryOutput) GoString() string

GoString returns the string representation

func (*CreateDirectoryOutput) SetDirectoryId added in v1.5.0

func (s *CreateDirectoryOutput) SetDirectoryId(v string) *CreateDirectoryOutput

SetDirectoryId sets the DirectoryId field's value.

func (CreateDirectoryOutput) String added in v0.6.5

func (s CreateDirectoryOutput) String() string

String returns the string representation

type CreateMicrosoftADInput added in v1.0.3

type CreateMicrosoftADInput struct {

	// A textual description for the directory. This label will appear on the AWS
	// console Directory Details page after the directory is created.
	Description *string `type:"string"`

	// AWS Microsoft AD is available in two editions: Standard and Enterprise. Enterprise
	// is the default.
	Edition *string `type:"string" enum:"DirectoryEdition"`

	// The fully qualified domain name for the directory, such as corp.example.com.
	// This name will resolve inside your VPC only. It does not need to be publicly
	// resolvable.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The password for the default administrative user named Admin.
	//
	// Password is a required field
	Password *string `type:"string" required:"true"`

	// The NetBIOS name for your domain. A short identifier for your domain, such
	// as CORP. If you don't specify a NetBIOS name, it will default to the first
	// part of your directory DNS. For example, CORP for the directory DNS corp.example.com.
	ShortName *string `type:"string"`

	// Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
	//
	// VpcSettings is a required field
	VpcSettings *DirectoryVpcSettings `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Creates a Microsoft AD in the AWS cloud.

func (CreateMicrosoftADInput) GoString added in v1.0.3

func (s CreateMicrosoftADInput) GoString() string

GoString returns the string representation

func (*CreateMicrosoftADInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*CreateMicrosoftADInput) SetEdition added in v1.12.58

SetEdition sets the Edition field's value.

func (*CreateMicrosoftADInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*CreateMicrosoftADInput) SetPassword added in v1.5.0

SetPassword sets the Password field's value.

func (*CreateMicrosoftADInput) SetShortName added in v1.5.0

SetShortName sets the ShortName field's value.

func (*CreateMicrosoftADInput) SetVpcSettings added in v1.5.0

SetVpcSettings sets the VpcSettings field's value.

func (CreateMicrosoftADInput) String added in v1.0.3

func (s CreateMicrosoftADInput) String() string

String returns the string representation

func (*CreateMicrosoftADInput) Validate added in v1.1.21

func (s *CreateMicrosoftADInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMicrosoftADOutput added in v1.0.3

type CreateMicrosoftADOutput struct {

	// The identifier of the directory that was created.
	DirectoryId *string `type:"string"`
	// contains filtered or unexported fields
}

Result of a CreateMicrosoftAD request.

func (CreateMicrosoftADOutput) GoString added in v1.0.3

func (s CreateMicrosoftADOutput) GoString() string

GoString returns the string representation

func (*CreateMicrosoftADOutput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (CreateMicrosoftADOutput) String added in v1.0.3

func (s CreateMicrosoftADOutput) String() string

String returns the string representation

type CreateSnapshotInput

type CreateSnapshotInput struct {

	// The identifier of the directory of which to take a snapshot.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The descriptive name to apply to the snapshot.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the CreateSnapshot operation.

func (CreateSnapshotInput) GoString added in v0.6.5

func (s CreateSnapshotInput) GoString() string

GoString returns the string representation

func (*CreateSnapshotInput) SetDirectoryId added in v1.5.0

func (s *CreateSnapshotInput) SetDirectoryId(v string) *CreateSnapshotInput

SetDirectoryId sets the DirectoryId field's value.

func (*CreateSnapshotInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (CreateSnapshotInput) String added in v0.6.5

func (s CreateSnapshotInput) String() string

String returns the string representation

func (*CreateSnapshotInput) Validate added in v1.1.21

func (s *CreateSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSnapshotOutput

type CreateSnapshotOutput struct {

	// The identifier of the snapshot that was created.
	SnapshotId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of the CreateSnapshot operation.

func (CreateSnapshotOutput) GoString added in v0.6.5

func (s CreateSnapshotOutput) GoString() string

GoString returns the string representation

func (*CreateSnapshotOutput) SetSnapshotId added in v1.5.0

func (s *CreateSnapshotOutput) SetSnapshotId(v string) *CreateSnapshotOutput

SetSnapshotId sets the SnapshotId field's value.

func (CreateSnapshotOutput) String added in v0.6.5

func (s CreateSnapshotOutput) String() string

String returns the string representation

type CreateTrustInput added in v1.0.3

type CreateTrustInput struct {

	// The IP addresses of the remote DNS server associated with RemoteDomainName.
	ConditionalForwarderIpAddrs []*string `type:"list"`

	// The Directory ID of the Microsoft AD in the AWS cloud for which to establish
	// the trust relationship.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The Fully Qualified Domain Name (FQDN) of the external domain for which to
	// create the trust relationship.
	//
	// RemoteDomainName is a required field
	RemoteDomainName *string `type:"string" required:"true"`

	// The direction of the trust relationship.
	//
	// TrustDirection is a required field
	TrustDirection *string `type:"string" required:"true" enum:"TrustDirection"`

	// The trust password. The must be the same password that was used when creating
	// the trust relationship on the external domain.
	//
	// TrustPassword is a required field
	TrustPassword *string `min:"1" type:"string" required:"true"`

	// The trust relationship type.
	TrustType *string `type:"string" enum:"TrustType"`
	// contains filtered or unexported fields
}

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.

func (CreateTrustInput) GoString added in v1.0.3

func (s CreateTrustInput) GoString() string

GoString returns the string representation

func (*CreateTrustInput) SetConditionalForwarderIpAddrs added in v1.5.0

func (s *CreateTrustInput) SetConditionalForwarderIpAddrs(v []*string) *CreateTrustInput

SetConditionalForwarderIpAddrs sets the ConditionalForwarderIpAddrs field's value.

func (*CreateTrustInput) SetDirectoryId added in v1.5.0

func (s *CreateTrustInput) SetDirectoryId(v string) *CreateTrustInput

SetDirectoryId sets the DirectoryId field's value.

func (*CreateTrustInput) SetRemoteDomainName added in v1.5.0

func (s *CreateTrustInput) SetRemoteDomainName(v string) *CreateTrustInput

SetRemoteDomainName sets the RemoteDomainName field's value.

func (*CreateTrustInput) SetTrustDirection added in v1.5.0

func (s *CreateTrustInput) SetTrustDirection(v string) *CreateTrustInput

SetTrustDirection sets the TrustDirection field's value.

func (*CreateTrustInput) SetTrustPassword added in v1.5.0

func (s *CreateTrustInput) SetTrustPassword(v string) *CreateTrustInput

SetTrustPassword sets the TrustPassword field's value.

func (*CreateTrustInput) SetTrustType added in v1.5.0

func (s *CreateTrustInput) SetTrustType(v string) *CreateTrustInput

SetTrustType sets the TrustType field's value.

func (CreateTrustInput) String added in v1.0.3

func (s CreateTrustInput) String() string

String returns the string representation

func (*CreateTrustInput) Validate added in v1.1.21

func (s *CreateTrustInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTrustOutput added in v1.0.3

type CreateTrustOutput struct {

	// A unique identifier for the trust relationship that was created.
	TrustId *string `type:"string"`
	// contains filtered or unexported fields
}

The result of a CreateTrust request.

func (CreateTrustOutput) GoString added in v1.0.3

func (s CreateTrustOutput) GoString() string

GoString returns the string representation

func (*CreateTrustOutput) SetTrustId added in v1.5.0

func (s *CreateTrustOutput) SetTrustId(v string) *CreateTrustOutput

SetTrustId sets the TrustId field's value.

func (CreateTrustOutput) String added in v1.0.3

func (s CreateTrustOutput) String() string

String returns the string representation

type DeleteConditionalForwarderInput added in v1.1.17

type DeleteConditionalForwarderInput struct {

	// The directory ID for which you are deleting the conditional forwarder.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The fully qualified domain name (FQDN) of the remote domain with which you
	// are deleting the conditional forwarder.
	//
	// RemoteDomainName is a required field
	RemoteDomainName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Deletes a conditional forwarder.

func (DeleteConditionalForwarderInput) GoString added in v1.1.17

GoString returns the string representation

func (*DeleteConditionalForwarderInput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (*DeleteConditionalForwarderInput) SetRemoteDomainName added in v1.5.0

SetRemoteDomainName sets the RemoteDomainName field's value.

func (DeleteConditionalForwarderInput) String added in v1.1.17

String returns the string representation

func (*DeleteConditionalForwarderInput) Validate added in v1.1.21

func (s *DeleteConditionalForwarderInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteConditionalForwarderOutput added in v1.1.17

type DeleteConditionalForwarderOutput struct {
	// contains filtered or unexported fields
}

The result of a DeleteConditionalForwarder request.

func (DeleteConditionalForwarderOutput) GoString added in v1.1.17

GoString returns the string representation

func (DeleteConditionalForwarderOutput) String added in v1.1.17

String returns the string representation

type DeleteDirectoryInput

type DeleteDirectoryInput struct {

	// The identifier of the directory to delete.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the DeleteDirectory operation.

func (DeleteDirectoryInput) GoString added in v0.6.5

func (s DeleteDirectoryInput) GoString() string

GoString returns the string representation

func (*DeleteDirectoryInput) SetDirectoryId added in v1.5.0

func (s *DeleteDirectoryInput) SetDirectoryId(v string) *DeleteDirectoryInput

SetDirectoryId sets the DirectoryId field's value.

func (DeleteDirectoryInput) String added in v0.6.5

func (s DeleteDirectoryInput) String() string

String returns the string representation

func (*DeleteDirectoryInput) Validate added in v1.1.21

func (s *DeleteDirectoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDirectoryOutput

type DeleteDirectoryOutput struct {

	// The directory identifier.
	DirectoryId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of the DeleteDirectory operation.

func (DeleteDirectoryOutput) GoString added in v0.6.5

func (s DeleteDirectoryOutput) GoString() string

GoString returns the string representation

func (*DeleteDirectoryOutput) SetDirectoryId added in v1.5.0

func (s *DeleteDirectoryOutput) SetDirectoryId(v string) *DeleteDirectoryOutput

SetDirectoryId sets the DirectoryId field's value.

func (DeleteDirectoryOutput) String added in v0.6.5

func (s DeleteDirectoryOutput) String() string

String returns the string representation

type DeleteSnapshotInput

type DeleteSnapshotInput struct {

	// The identifier of the directory snapshot to be deleted.
	//
	// SnapshotId is a required field
	SnapshotId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the DeleteSnapshot operation.

func (DeleteSnapshotInput) GoString added in v0.6.5

func (s DeleteSnapshotInput) GoString() string

GoString returns the string representation

func (*DeleteSnapshotInput) SetSnapshotId added in v1.5.0

func (s *DeleteSnapshotInput) SetSnapshotId(v string) *DeleteSnapshotInput

SetSnapshotId sets the SnapshotId field's value.

func (DeleteSnapshotInput) String added in v0.6.5

func (s DeleteSnapshotInput) String() string

String returns the string representation

func (*DeleteSnapshotInput) Validate added in v1.1.21

func (s *DeleteSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSnapshotOutput

type DeleteSnapshotOutput struct {

	// The identifier of the directory snapshot that was deleted.
	SnapshotId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of the DeleteSnapshot operation.

func (DeleteSnapshotOutput) GoString added in v0.6.5

func (s DeleteSnapshotOutput) GoString() string

GoString returns the string representation

func (*DeleteSnapshotOutput) SetSnapshotId added in v1.5.0

func (s *DeleteSnapshotOutput) SetSnapshotId(v string) *DeleteSnapshotOutput

SetSnapshotId sets the SnapshotId field's value.

func (DeleteSnapshotOutput) String added in v0.6.5

func (s DeleteSnapshotOutput) String() string

String returns the string representation

type DeleteTrustInput added in v1.0.3

type DeleteTrustInput struct {

	// Delete a conditional forwarder as part of a DeleteTrustRequest.
	DeleteAssociatedConditionalForwarder *bool `type:"boolean"`

	// The Trust ID of the trust relationship to be deleted.
	//
	// TrustId is a required field
	TrustId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the external domain.

func (DeleteTrustInput) GoString added in v1.0.3

func (s DeleteTrustInput) GoString() string

GoString returns the string representation

func (*DeleteTrustInput) SetDeleteAssociatedConditionalForwarder added in v1.5.0

func (s *DeleteTrustInput) SetDeleteAssociatedConditionalForwarder(v bool) *DeleteTrustInput

SetDeleteAssociatedConditionalForwarder sets the DeleteAssociatedConditionalForwarder field's value.

func (*DeleteTrustInput) SetTrustId added in v1.5.0

func (s *DeleteTrustInput) SetTrustId(v string) *DeleteTrustInput

SetTrustId sets the TrustId field's value.

func (DeleteTrustInput) String added in v1.0.3

func (s DeleteTrustInput) String() string

String returns the string representation

func (*DeleteTrustInput) Validate added in v1.1.21

func (s *DeleteTrustInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTrustOutput added in v1.0.3

type DeleteTrustOutput struct {

	// The Trust ID of the trust relationship that was deleted.
	TrustId *string `type:"string"`
	// contains filtered or unexported fields
}

The result of a DeleteTrust request.

func (DeleteTrustOutput) GoString added in v1.0.3

func (s DeleteTrustOutput) GoString() string

GoString returns the string representation

func (*DeleteTrustOutput) SetTrustId added in v1.5.0

func (s *DeleteTrustOutput) SetTrustId(v string) *DeleteTrustOutput

SetTrustId sets the TrustId field's value.

func (DeleteTrustOutput) String added in v1.0.3

func (s DeleteTrustOutput) String() string

String returns the string representation

type DeregisterEventTopicInput added in v1.1.8

type DeregisterEventTopicInput struct {

	// The Directory ID to remove as a publisher. This directory will no longer
	// send messages to the specified SNS topic.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The name of the SNS topic from which to remove the directory as a publisher.
	//
	// TopicName is a required field
	TopicName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Removes the specified directory as a publisher to the specified SNS topic.

func (DeregisterEventTopicInput) GoString added in v1.1.8

func (s DeregisterEventTopicInput) GoString() string

GoString returns the string representation

func (*DeregisterEventTopicInput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (*DeregisterEventTopicInput) SetTopicName added in v1.5.0

SetTopicName sets the TopicName field's value.

func (DeregisterEventTopicInput) String added in v1.1.8

func (s DeregisterEventTopicInput) String() string

String returns the string representation

func (*DeregisterEventTopicInput) Validate added in v1.1.21

func (s *DeregisterEventTopicInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterEventTopicOutput added in v1.1.8

type DeregisterEventTopicOutput struct {
	// contains filtered or unexported fields
}

The result of a DeregisterEventTopic request.

func (DeregisterEventTopicOutput) GoString added in v1.1.8

func (s DeregisterEventTopicOutput) GoString() string

GoString returns the string representation

func (DeregisterEventTopicOutput) String added in v1.1.8

String returns the string representation

type DescribeConditionalForwardersInput added in v1.1.17

type DescribeConditionalForwardersInput struct {

	// The directory ID for which to get the list of associated conditional forwarders.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The fully qualified domain names (FQDN) of the remote domains for which to
	// get the list of associated conditional forwarders. If this member is null,
	// all conditional forwarders are returned.
	RemoteDomainNames []*string `type:"list"`
	// contains filtered or unexported fields
}

Describes a conditional forwarder.

func (DescribeConditionalForwardersInput) GoString added in v1.1.17

GoString returns the string representation

func (*DescribeConditionalForwardersInput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (*DescribeConditionalForwardersInput) SetRemoteDomainNames added in v1.5.0

SetRemoteDomainNames sets the RemoteDomainNames field's value.

func (DescribeConditionalForwardersInput) String added in v1.1.17

String returns the string representation

func (*DescribeConditionalForwardersInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeConditionalForwardersOutput added in v1.1.17

type DescribeConditionalForwardersOutput struct {

	// The list of conditional forwarders that have been created.
	ConditionalForwarders []*ConditionalForwarder `type:"list"`
	// contains filtered or unexported fields
}

The result of a DescribeConditionalForwarder request.

func (DescribeConditionalForwardersOutput) GoString added in v1.1.17

GoString returns the string representation

func (*DescribeConditionalForwardersOutput) SetConditionalForwarders added in v1.5.0

SetConditionalForwarders sets the ConditionalForwarders field's value.

func (DescribeConditionalForwardersOutput) String added in v1.1.17

String returns the string representation

type DescribeDirectoriesInput

type DescribeDirectoriesInput struct {

	// A list of identifiers of the directories for which to obtain the information.
	// If this member is null, all directories that belong to the current account
	// are returned.
	//
	// An empty list results in an InvalidParameterException being thrown.
	DirectoryIds []*string `type:"list"`

	// The maximum number of items to return. If this value is zero, the maximum
	// number of items is specified by the limitations of the operation.
	Limit *int64 `type:"integer"`

	// The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
	// Pass null if this is the first call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the DescribeDirectories operation.

func (DescribeDirectoriesInput) GoString added in v0.6.5

func (s DescribeDirectoriesInput) GoString() string

GoString returns the string representation

func (*DescribeDirectoriesInput) SetDirectoryIds added in v1.5.0

func (s *DescribeDirectoriesInput) SetDirectoryIds(v []*string) *DescribeDirectoriesInput

SetDirectoryIds sets the DirectoryIds field's value.

func (*DescribeDirectoriesInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeDirectoriesInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeDirectoriesInput) String added in v0.6.5

func (s DescribeDirectoriesInput) String() string

String returns the string representation

type DescribeDirectoriesOutput

type DescribeDirectoriesOutput struct {

	// The list of DirectoryDescription objects that were retrieved.
	//
	// It is possible that this list contains less than the number of items specified
	// in the Limit member of the request. This occurs if there are less than the
	// requested number of items left to retrieve, or if the limitations of the
	// operation have been exceeded.
	DirectoryDescriptions []*DirectoryDescription `type:"list"`

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeDirectories to retrieve the next
	// set of items.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the results of the DescribeDirectories operation.

func (DescribeDirectoriesOutput) GoString added in v0.6.5

func (s DescribeDirectoriesOutput) GoString() string

GoString returns the string representation

func (*DescribeDirectoriesOutput) SetDirectoryDescriptions added in v1.5.0

SetDirectoryDescriptions sets the DirectoryDescriptions field's value.

func (*DescribeDirectoriesOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeDirectoriesOutput) String added in v0.6.5

func (s DescribeDirectoriesOutput) String() string

String returns the string representation

type DescribeDomainControllersInput added in v1.10.8

type DescribeDomainControllersInput struct {

	// Identifier of the directory for which to retrieve the domain controller information.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// A list of identifiers for the domain controllers whose information will be
	// provided.
	DomainControllerIds []*string `type:"list"`

	// The maximum number of items to return.
	Limit *int64 `type:"integer"`

	// The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers.
	// Pass null if this is the first call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDomainControllersInput) GoString added in v1.10.8

GoString returns the string representation

func (*DescribeDomainControllersInput) SetDirectoryId added in v1.10.8

SetDirectoryId sets the DirectoryId field's value.

func (*DescribeDomainControllersInput) SetDomainControllerIds added in v1.10.8

func (s *DescribeDomainControllersInput) SetDomainControllerIds(v []*string) *DescribeDomainControllersInput

SetDomainControllerIds sets the DomainControllerIds field's value.

func (*DescribeDomainControllersInput) SetLimit added in v1.10.8

SetLimit sets the Limit field's value.

func (*DescribeDomainControllersInput) SetNextToken added in v1.10.8

SetNextToken sets the NextToken field's value.

func (DescribeDomainControllersInput) String added in v1.10.8

String returns the string representation

func (*DescribeDomainControllersInput) Validate added in v1.10.8

func (s *DescribeDomainControllersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDomainControllersOutput added in v1.10.8

type DescribeDomainControllersOutput struct {

	// List of the DomainController objects that were retrieved.
	DomainControllers []*DomainController `type:"list"`

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeDomainControllers retrieve the
	// next set of items.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDomainControllersOutput) GoString added in v1.10.8

GoString returns the string representation

func (*DescribeDomainControllersOutput) SetDomainControllers added in v1.10.8

SetDomainControllers sets the DomainControllers field's value.

func (*DescribeDomainControllersOutput) SetNextToken added in v1.10.8

SetNextToken sets the NextToken field's value.

func (DescribeDomainControllersOutput) String added in v1.10.8

String returns the string representation

type DescribeEventTopicsInput added in v1.1.8

type DescribeEventTopicsInput struct {

	// The Directory ID for which to get the list of associated SNS topics. If this
	// member is null, associations for all Directory IDs are returned.
	DirectoryId *string `type:"string"`

	// A list of SNS topic names for which to obtain the information. If this member
	// is null, all associations for the specified Directory ID are returned.
	//
	// An empty list results in an InvalidParameterException being thrown.
	TopicNames []*string `type:"list"`
	// contains filtered or unexported fields
}

Describes event topics.

func (DescribeEventTopicsInput) GoString added in v1.1.8

func (s DescribeEventTopicsInput) GoString() string

GoString returns the string representation

func (*DescribeEventTopicsInput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (*DescribeEventTopicsInput) SetTopicNames added in v1.5.0

SetTopicNames sets the TopicNames field's value.

func (DescribeEventTopicsInput) String added in v1.1.8

func (s DescribeEventTopicsInput) String() string

String returns the string representation

type DescribeEventTopicsOutput added in v1.1.8

type DescribeEventTopicsOutput struct {

	// A list of SNS topic names that receive status messages from the specified
	// Directory ID.
	EventTopics []*EventTopic `type:"list"`
	// contains filtered or unexported fields
}

The result of a DescribeEventTopic request.

func (DescribeEventTopicsOutput) GoString added in v1.1.8

func (s DescribeEventTopicsOutput) GoString() string

GoString returns the string representation

func (*DescribeEventTopicsOutput) SetEventTopics added in v1.5.0

SetEventTopics sets the EventTopics field's value.

func (DescribeEventTopicsOutput) String added in v1.1.8

func (s DescribeEventTopicsOutput) String() string

String returns the string representation

type DescribeSnapshotsInput

type DescribeSnapshotsInput struct {

	// The identifier of the directory for which to retrieve snapshot information.
	DirectoryId *string `type:"string"`

	// The maximum number of objects to return.
	Limit *int64 `type:"integer"`

	// The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots.
	// Pass null if this is the first call.
	NextToken *string `type:"string"`

	// A list of identifiers of the snapshots to obtain the information for. If
	// this member is null or empty, all snapshots are returned using the Limit
	// and NextToken members.
	SnapshotIds []*string `type:"list"`
	// contains filtered or unexported fields
}

Contains the inputs for the DescribeSnapshots operation.

func (DescribeSnapshotsInput) GoString added in v0.6.5

func (s DescribeSnapshotsInput) GoString() string

GoString returns the string representation

func (*DescribeSnapshotsInput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (*DescribeSnapshotsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeSnapshotsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeSnapshotsInput) SetSnapshotIds added in v1.5.0

func (s *DescribeSnapshotsInput) SetSnapshotIds(v []*string) *DescribeSnapshotsInput

SetSnapshotIds sets the SnapshotIds field's value.

func (DescribeSnapshotsInput) String added in v0.6.5

func (s DescribeSnapshotsInput) String() string

String returns the string representation

type DescribeSnapshotsOutput

type DescribeSnapshotsOutput struct {

	// If not null, more results are available. Pass this value in the NextToken
	// member of a subsequent call to DescribeSnapshots.
	NextToken *string `type:"string"`

	// The list of Snapshot objects that were retrieved.
	//
	// It is possible that this list contains less than the number of items specified
	// in the Limit member of the request. This occurs if there are less than the
	// requested number of items left to retrieve, or if the limitations of the
	// operation have been exceeded.
	Snapshots []*Snapshot `type:"list"`
	// contains filtered or unexported fields
}

Contains the results of the DescribeSnapshots operation.

func (DescribeSnapshotsOutput) GoString added in v0.6.5

func (s DescribeSnapshotsOutput) GoString() string

GoString returns the string representation

func (*DescribeSnapshotsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeSnapshotsOutput) SetSnapshots added in v1.5.0

SetSnapshots sets the Snapshots field's value.

func (DescribeSnapshotsOutput) String added in v0.6.5

func (s DescribeSnapshotsOutput) String() string

String returns the string representation

type DescribeTrustsInput added in v1.0.3

type DescribeTrustsInput struct {

	// The Directory ID of the AWS directory that is a part of the requested trust
	// relationship.
	DirectoryId *string `type:"string"`

	// The maximum number of objects to return.
	Limit *int64 `type:"integer"`

	// The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts.
	// Pass null if this is the first call.
	NextToken *string `type:"string"`

	// A list of identifiers of the trust relationships for which to obtain the
	// information. If this member is null, all trust relationships that belong
	// to the current account are returned.
	//
	// An empty list results in an InvalidParameterException being thrown.
	TrustIds []*string `type:"list"`
	// contains filtered or unexported fields
}

Describes the trust relationships for a particular Microsoft AD in the AWS cloud. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships.

func (DescribeTrustsInput) GoString added in v1.0.3

func (s DescribeTrustsInput) GoString() string

GoString returns the string representation

func (*DescribeTrustsInput) SetDirectoryId added in v1.5.0

func (s *DescribeTrustsInput) SetDirectoryId(v string) *DescribeTrustsInput

SetDirectoryId sets the DirectoryId field's value.

func (*DescribeTrustsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeTrustsInput) SetNextToken added in v1.5.0

func (s *DescribeTrustsInput) SetNextToken(v string) *DescribeTrustsInput

SetNextToken sets the NextToken field's value.

func (*DescribeTrustsInput) SetTrustIds added in v1.5.0

func (s *DescribeTrustsInput) SetTrustIds(v []*string) *DescribeTrustsInput

SetTrustIds sets the TrustIds field's value.

func (DescribeTrustsInput) String added in v1.0.3

func (s DescribeTrustsInput) String() string

String returns the string representation

type DescribeTrustsOutput added in v1.0.3

type DescribeTrustsOutput struct {

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeTrusts to retrieve the next set
	// of items.
	NextToken *string `type:"string"`

	// The list of Trust objects that were retrieved.
	//
	// It is possible that this list contains less than the number of items specified
	// in the Limit member of the request. This occurs if there are less than the
	// requested number of items left to retrieve, or if the limitations of the
	// operation have been exceeded.
	Trusts []*Trust `type:"list"`
	// contains filtered or unexported fields
}

The result of a DescribeTrust request.

func (DescribeTrustsOutput) GoString added in v1.0.3

func (s DescribeTrustsOutput) GoString() string

GoString returns the string representation

func (*DescribeTrustsOutput) SetNextToken added in v1.5.0

func (s *DescribeTrustsOutput) SetNextToken(v string) *DescribeTrustsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeTrustsOutput) SetTrusts added in v1.5.0

func (s *DescribeTrustsOutput) SetTrusts(v []*Trust) *DescribeTrustsOutput

SetTrusts sets the Trusts field's value.

func (DescribeTrustsOutput) String added in v1.0.3

func (s DescribeTrustsOutput) String() string

String returns the string representation

type DirectoryConnectSettings

type DirectoryConnectSettings struct {

	// A list of one or more IP addresses of DNS servers or domain controllers in
	// the on-premises directory.
	//
	// CustomerDnsIps is a required field
	CustomerDnsIps []*string `type:"list" required:"true"`

	// The username of an account in the on-premises directory that is used to connect
	// to the directory. This account must have the following privileges:
	//
	//    * Read users and groups
	//
	//    * Create computer objects
	//
	//    * Join computers to the domain
	//
	// CustomerUserName is a required field
	CustomerUserName *string `min:"1" type:"string" required:"true"`

	// A list of subnet identifiers in the VPC in which the AD Connector is created.
	//
	// SubnetIds is a required field
	SubnetIds []*string `type:"list" required:"true"`

	// The identifier of the VPC in which the AD Connector is created.
	//
	// VpcId is a required field
	VpcId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information for the ConnectDirectory operation when an AD Connector directory is being created.

func (DirectoryConnectSettings) GoString added in v0.6.5

func (s DirectoryConnectSettings) GoString() string

GoString returns the string representation

func (*DirectoryConnectSettings) SetCustomerDnsIps added in v1.5.0

func (s *DirectoryConnectSettings) SetCustomerDnsIps(v []*string) *DirectoryConnectSettings

SetCustomerDnsIps sets the CustomerDnsIps field's value.

func (*DirectoryConnectSettings) SetCustomerUserName added in v1.5.0

func (s *DirectoryConnectSettings) SetCustomerUserName(v string) *DirectoryConnectSettings

SetCustomerUserName sets the CustomerUserName field's value.

func (*DirectoryConnectSettings) SetSubnetIds added in v1.5.0

SetSubnetIds sets the SubnetIds field's value.

func (*DirectoryConnectSettings) SetVpcId added in v1.5.0

SetVpcId sets the VpcId field's value.

func (DirectoryConnectSettings) String added in v0.6.5

func (s DirectoryConnectSettings) String() string

String returns the string representation

func (*DirectoryConnectSettings) Validate added in v1.1.21

func (s *DirectoryConnectSettings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DirectoryConnectSettingsDescription

type DirectoryConnectSettingsDescription struct {

	// A list of the Availability Zones that the directory is in.
	AvailabilityZones []*string `type:"list"`

	// The IP addresses of the AD Connector servers.
	ConnectIps []*string `type:"list"`

	// The username of the service account in the on-premises directory.
	CustomerUserName *string `min:"1" type:"string"`

	// The security group identifier for the AD Connector directory.
	SecurityGroupId *string `type:"string"`

	// A list of subnet identifiers in the VPC that the AD connector is in.
	SubnetIds []*string `type:"list"`

	// The identifier of the VPC that the AD Connector is in.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about an AD Connector directory.

func (DirectoryConnectSettingsDescription) GoString added in v0.6.5

GoString returns the string representation

func (*DirectoryConnectSettingsDescription) SetAvailabilityZones added in v1.5.0

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*DirectoryConnectSettingsDescription) SetConnectIps added in v1.5.0

SetConnectIps sets the ConnectIps field's value.

func (*DirectoryConnectSettingsDescription) SetCustomerUserName added in v1.5.0

SetCustomerUserName sets the CustomerUserName field's value.

func (*DirectoryConnectSettingsDescription) SetSecurityGroupId added in v1.5.0

SetSecurityGroupId sets the SecurityGroupId field's value.

func (*DirectoryConnectSettingsDescription) SetSubnetIds added in v1.5.0

SetSubnetIds sets the SubnetIds field's value.

func (*DirectoryConnectSettingsDescription) SetVpcId added in v1.5.0

SetVpcId sets the VpcId field's value.

func (DirectoryConnectSettingsDescription) String added in v0.6.5

String returns the string representation

type DirectoryDescription

type DirectoryDescription struct {

	// The access URL for the directory, such as http://<alias>.awsapps.com. If
	// no alias has been created for the directory, <alias> is the directory identifier,
	// such as d-XXXXXXXXXX.
	AccessUrl *string `min:"1" type:"string"`

	// The alias for the directory. If no alias has been created for the directory,
	// the alias is the directory identifier, such as d-XXXXXXXXXX.
	Alias *string `min:"1" type:"string"`

	// A DirectoryConnectSettingsDescription object that contains additional information
	// about an AD Connector directory. This member is only present if the directory
	// is an AD Connector directory.
	ConnectSettings *DirectoryConnectSettingsDescription `type:"structure"`

	// The textual description for the directory.
	Description *string `type:"string"`

	// The desired number of domain controllers in the directory if the directory
	// is Microsoft AD.
	DesiredNumberOfDomainControllers *int64 `min:"2" type:"integer"`

	// The directory identifier.
	DirectoryId *string `type:"string"`

	// The IP addresses of the DNS servers for the directory. For a Simple AD or
	// Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft
	// AD directory servers. For an AD Connector directory, these are the IP addresses
	// of the DNS servers or domain controllers in the on-premises directory to
	// which the AD Connector is connected.
	DnsIpAddrs []*string `type:"list"`

	// The edition associated with this directory.
	Edition *string `type:"string" enum:"DirectoryEdition"`

	// Specifies when the directory was created.
	LaunchTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The fully-qualified name of the directory.
	Name *string `type:"string"`

	// A RadiusSettings object that contains information about the RADIUS server
	// configured for this directory.
	RadiusSettings *RadiusSettings `type:"structure"`

	// The status of the RADIUS MFA server connection.
	RadiusStatus *string `type:"string" enum:"RadiusStatus"`

	// The short name of the directory.
	ShortName *string `type:"string"`

	// The directory size.
	Size *string `type:"string" enum:"DirectorySize"`

	// Indicates if single-sign on is enabled for the directory. For more information,
	// see EnableSso and DisableSso.
	SsoEnabled *bool `type:"boolean"`

	// The current stage of the directory.
	Stage *string `type:"string" enum:"DirectoryStage"`

	// The date and time that the stage was last updated.
	StageLastUpdatedDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Additional information about the directory stage.
	StageReason *string `type:"string"`

	// The directory size.
	Type *string `type:"string" enum:"DirectoryType"`

	// A DirectoryVpcSettingsDescription object that contains additional information
	// about a directory. This member is only present if the directory is a Simple
	// AD or Managed AD directory.
	VpcSettings *DirectoryVpcSettingsDescription `type:"structure"`
	// contains filtered or unexported fields
}

Contains information about an AWS Directory Service directory.

func (DirectoryDescription) GoString added in v0.6.5

func (s DirectoryDescription) GoString() string

GoString returns the string representation

func (*DirectoryDescription) SetAccessUrl added in v1.5.0

func (s *DirectoryDescription) SetAccessUrl(v string) *DirectoryDescription

SetAccessUrl sets the AccessUrl field's value.

func (*DirectoryDescription) SetAlias added in v1.5.0

SetAlias sets the Alias field's value.

func (*DirectoryDescription) SetConnectSettings added in v1.5.0

SetConnectSettings sets the ConnectSettings field's value.

func (*DirectoryDescription) SetDescription added in v1.5.0

func (s *DirectoryDescription) SetDescription(v string) *DirectoryDescription

SetDescription sets the Description field's value.

func (*DirectoryDescription) SetDesiredNumberOfDomainControllers added in v1.10.8

func (s *DirectoryDescription) SetDesiredNumberOfDomainControllers(v int64) *DirectoryDescription

SetDesiredNumberOfDomainControllers sets the DesiredNumberOfDomainControllers field's value.

func (*DirectoryDescription) SetDirectoryId added in v1.5.0

func (s *DirectoryDescription) SetDirectoryId(v string) *DirectoryDescription

SetDirectoryId sets the DirectoryId field's value.

func (*DirectoryDescription) SetDnsIpAddrs added in v1.5.0

func (s *DirectoryDescription) SetDnsIpAddrs(v []*string) *DirectoryDescription

SetDnsIpAddrs sets the DnsIpAddrs field's value.

func (*DirectoryDescription) SetEdition added in v1.12.58

SetEdition sets the Edition field's value.

func (*DirectoryDescription) SetLaunchTime added in v1.5.0

func (s *DirectoryDescription) SetLaunchTime(v time.Time) *DirectoryDescription

SetLaunchTime sets the LaunchTime field's value.

func (*DirectoryDescription) SetName added in v1.5.0

SetName sets the Name field's value.

func (*DirectoryDescription) SetRadiusSettings added in v1.5.0

func (s *DirectoryDescription) SetRadiusSettings(v *RadiusSettings) *DirectoryDescription

SetRadiusSettings sets the RadiusSettings field's value.

func (*DirectoryDescription) SetRadiusStatus added in v1.5.0

func (s *DirectoryDescription) SetRadiusStatus(v string) *DirectoryDescription

SetRadiusStatus sets the RadiusStatus field's value.

func (*DirectoryDescription) SetShortName added in v1.5.0

func (s *DirectoryDescription) SetShortName(v string) *DirectoryDescription

SetShortName sets the ShortName field's value.

func (*DirectoryDescription) SetSize added in v1.5.0

SetSize sets the Size field's value.

func (*DirectoryDescription) SetSsoEnabled added in v1.5.0

func (s *DirectoryDescription) SetSsoEnabled(v bool) *DirectoryDescription

SetSsoEnabled sets the SsoEnabled field's value.

func (*DirectoryDescription) SetStage added in v1.5.0

SetStage sets the Stage field's value.

func (*DirectoryDescription) SetStageLastUpdatedDateTime added in v1.5.0

func (s *DirectoryDescription) SetStageLastUpdatedDateTime(v time.Time) *DirectoryDescription

SetStageLastUpdatedDateTime sets the StageLastUpdatedDateTime field's value.

func (*DirectoryDescription) SetStageReason added in v1.5.0

func (s *DirectoryDescription) SetStageReason(v string) *DirectoryDescription

SetStageReason sets the StageReason field's value.

func (*DirectoryDescription) SetType added in v1.5.0

SetType sets the Type field's value.

func (*DirectoryDescription) SetVpcSettings added in v1.5.0

SetVpcSettings sets the VpcSettings field's value.

func (DirectoryDescription) String added in v0.6.5

func (s DirectoryDescription) String() string

String returns the string representation

type DirectoryLimits

type DirectoryLimits struct {

	// The current number of cloud directories in the region.
	CloudOnlyDirectoriesCurrentCount *int64 `type:"integer"`

	// The maximum number of cloud directories allowed in the region.
	CloudOnlyDirectoriesLimit *int64 `type:"integer"`

	// Indicates if the cloud directory limit has been reached.
	CloudOnlyDirectoriesLimitReached *bool `type:"boolean"`

	// The current number of Microsoft AD directories in the region.
	CloudOnlyMicrosoftADCurrentCount *int64 `type:"integer"`

	// The maximum number of Microsoft AD directories allowed in the region.
	CloudOnlyMicrosoftADLimit *int64 `type:"integer"`

	// Indicates if the Microsoft AD directory limit has been reached.
	CloudOnlyMicrosoftADLimitReached *bool `type:"boolean"`

	// The current number of connected directories in the region.
	ConnectedDirectoriesCurrentCount *int64 `type:"integer"`

	// The maximum number of connected directories allowed in the region.
	ConnectedDirectoriesLimit *int64 `type:"integer"`

	// Indicates if the connected directory limit has been reached.
	ConnectedDirectoriesLimitReached *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains directory limit information for a region.

func (DirectoryLimits) GoString added in v0.6.5

func (s DirectoryLimits) GoString() string

GoString returns the string representation

func (*DirectoryLimits) SetCloudOnlyDirectoriesCurrentCount added in v1.5.0

func (s *DirectoryLimits) SetCloudOnlyDirectoriesCurrentCount(v int64) *DirectoryLimits

SetCloudOnlyDirectoriesCurrentCount sets the CloudOnlyDirectoriesCurrentCount field's value.

func (*DirectoryLimits) SetCloudOnlyDirectoriesLimit added in v1.5.0

func (s *DirectoryLimits) SetCloudOnlyDirectoriesLimit(v int64) *DirectoryLimits

SetCloudOnlyDirectoriesLimit sets the CloudOnlyDirectoriesLimit field's value.

func (*DirectoryLimits) SetCloudOnlyDirectoriesLimitReached added in v1.5.0

func (s *DirectoryLimits) SetCloudOnlyDirectoriesLimitReached(v bool) *DirectoryLimits

SetCloudOnlyDirectoriesLimitReached sets the CloudOnlyDirectoriesLimitReached field's value.

func (*DirectoryLimits) SetCloudOnlyMicrosoftADCurrentCount added in v1.5.0

func (s *DirectoryLimits) SetCloudOnlyMicrosoftADCurrentCount(v int64) *DirectoryLimits

SetCloudOnlyMicrosoftADCurrentCount sets the CloudOnlyMicrosoftADCurrentCount field's value.

func (*DirectoryLimits) SetCloudOnlyMicrosoftADLimit added in v1.5.0

func (s *DirectoryLimits) SetCloudOnlyMicrosoftADLimit(v int64) *DirectoryLimits

SetCloudOnlyMicrosoftADLimit sets the CloudOnlyMicrosoftADLimit field's value.

func (*DirectoryLimits) SetCloudOnlyMicrosoftADLimitReached added in v1.5.0

func (s *DirectoryLimits) SetCloudOnlyMicrosoftADLimitReached(v bool) *DirectoryLimits

SetCloudOnlyMicrosoftADLimitReached sets the CloudOnlyMicrosoftADLimitReached field's value.

func (*DirectoryLimits) SetConnectedDirectoriesCurrentCount added in v1.5.0

func (s *DirectoryLimits) SetConnectedDirectoriesCurrentCount(v int64) *DirectoryLimits

SetConnectedDirectoriesCurrentCount sets the ConnectedDirectoriesCurrentCount field's value.

func (*DirectoryLimits) SetConnectedDirectoriesLimit added in v1.5.0

func (s *DirectoryLimits) SetConnectedDirectoriesLimit(v int64) *DirectoryLimits

SetConnectedDirectoriesLimit sets the ConnectedDirectoriesLimit field's value.

func (*DirectoryLimits) SetConnectedDirectoriesLimitReached added in v1.5.0

func (s *DirectoryLimits) SetConnectedDirectoriesLimitReached(v bool) *DirectoryLimits

SetConnectedDirectoriesLimitReached sets the ConnectedDirectoriesLimitReached field's value.

func (DirectoryLimits) String added in v0.6.5

func (s DirectoryLimits) String() string

String returns the string representation

type DirectoryService

type DirectoryService struct {
	*client.Client
}

DirectoryService provides the API operation methods for making requests to AWS Directory Service. See this package's package overview docs for details on the service.

DirectoryService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the DirectoryService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a DirectoryService client from just a session.
svc := directoryservice.New(mySession)

// Create a DirectoryService client with additional configuration
svc := directoryservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*DirectoryService) AddIpRoutes added in v1.2.10

func (c *DirectoryService) AddIpRoutes(input *AddIpRoutesInput) (*AddIpRoutesOutput, error)

AddIpRoutes API operation for AWS Directory Service.

If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation AddIpRoutes for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The specified entity already exists.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeIpRouteLimitExceededException "IpRouteLimitExceededException" The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/AddIpRoutes

func (*DirectoryService) AddIpRoutesRequest added in v1.2.10

func (c *DirectoryService) AddIpRoutesRequest(input *AddIpRoutesInput) (req *request.Request, output *AddIpRoutesOutput)

AddIpRoutesRequest generates a "aws/request.Request" representing the client's request for the AddIpRoutes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddIpRoutes for more information on using the AddIpRoutes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddIpRoutesRequest method.
req, resp := client.AddIpRoutesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/AddIpRoutes

func (*DirectoryService) AddIpRoutesWithContext added in v1.8.0

func (c *DirectoryService) AddIpRoutesWithContext(ctx aws.Context, input *AddIpRoutesInput, opts ...request.Option) (*AddIpRoutesOutput, error)

AddIpRoutesWithContext is the same as AddIpRoutes with the addition of the ability to pass a context and additional request options.

See AddIpRoutes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) AddTagsToResource added in v1.2.4

func (c *DirectoryService) AddTagsToResource(input *AddTagsToResourceInput) (*AddTagsToResourceOutput, error)

AddTagsToResource API operation for AWS Directory Service.

Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation AddTagsToResource for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeTagLimitExceededException "TagLimitExceededException" The maximum allowed number of tags was exceeded.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/AddTagsToResource

func (*DirectoryService) AddTagsToResourceRequest added in v1.2.4

func (c *DirectoryService) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *AddTagsToResourceOutput)

AddTagsToResourceRequest generates a "aws/request.Request" representing the client's request for the AddTagsToResource operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTagsToResource for more information on using the AddTagsToResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddTagsToResourceRequest method.
req, resp := client.AddTagsToResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/AddTagsToResource

func (*DirectoryService) AddTagsToResourceWithContext added in v1.8.0

func (c *DirectoryService) AddTagsToResourceWithContext(ctx aws.Context, input *AddTagsToResourceInput, opts ...request.Option) (*AddTagsToResourceOutput, error)

AddTagsToResourceWithContext is the same as AddTagsToResource with the addition of the ability to pass a context and additional request options.

See AddTagsToResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) CancelSchemaExtension added in v1.5.5

CancelSchemaExtension API operation for AWS Directory Service.

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation CancelSchemaExtension for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CancelSchemaExtension

func (*DirectoryService) CancelSchemaExtensionRequest added in v1.5.5

func (c *DirectoryService) CancelSchemaExtensionRequest(input *CancelSchemaExtensionInput) (req *request.Request, output *CancelSchemaExtensionOutput)

CancelSchemaExtensionRequest generates a "aws/request.Request" representing the client's request for the CancelSchemaExtension operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelSchemaExtension for more information on using the CancelSchemaExtension API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CancelSchemaExtensionRequest method.
req, resp := client.CancelSchemaExtensionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CancelSchemaExtension

func (*DirectoryService) CancelSchemaExtensionWithContext added in v1.8.0

func (c *DirectoryService) CancelSchemaExtensionWithContext(ctx aws.Context, input *CancelSchemaExtensionInput, opts ...request.Option) (*CancelSchemaExtensionOutput, error)

CancelSchemaExtensionWithContext is the same as CancelSchemaExtension with the addition of the ability to pass a context and additional request options.

See CancelSchemaExtension for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) ConnectDirectory

func (c *DirectoryService) ConnectDirectory(input *ConnectDirectoryInput) (*ConnectDirectoryOutput, error)

ConnectDirectory API operation for AWS Directory Service.

Creates an AD Connector to connect to an on-premises directory.

Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation ConnectDirectory for usage and error information.

Returned Error Codes:

  • ErrCodeDirectoryLimitExceededException "DirectoryLimitExceededException" The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ConnectDirectory

func (*DirectoryService) ConnectDirectoryRequest

func (c *DirectoryService) ConnectDirectoryRequest(input *ConnectDirectoryInput) (req *request.Request, output *ConnectDirectoryOutput)

ConnectDirectoryRequest generates a "aws/request.Request" representing the client's request for the ConnectDirectory operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ConnectDirectory for more information on using the ConnectDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ConnectDirectoryRequest method.
req, resp := client.ConnectDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ConnectDirectory

func (*DirectoryService) ConnectDirectoryWithContext added in v1.8.0

func (c *DirectoryService) ConnectDirectoryWithContext(ctx aws.Context, input *ConnectDirectoryInput, opts ...request.Option) (*ConnectDirectoryOutput, error)

ConnectDirectoryWithContext is the same as ConnectDirectory with the addition of the ability to pass a context and additional request options.

See ConnectDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) CreateAlias

func (c *DirectoryService) CreateAlias(input *CreateAliasInput) (*CreateAliasOutput, error)

CreateAlias API operation for AWS Directory Service.

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com.

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation CreateAlias for usage and error information.

Returned Error Codes:

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The specified entity already exists.

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateAlias

func (*DirectoryService) CreateAliasRequest

func (c *DirectoryService) CreateAliasRequest(input *CreateAliasInput) (req *request.Request, output *CreateAliasOutput)

CreateAliasRequest generates a "aws/request.Request" representing the client's request for the CreateAlias operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAlias for more information on using the CreateAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAliasRequest method.
req, resp := client.CreateAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateAlias

func (*DirectoryService) CreateAliasWithContext added in v1.8.0

func (c *DirectoryService) CreateAliasWithContext(ctx aws.Context, input *CreateAliasInput, opts ...request.Option) (*CreateAliasOutput, error)

CreateAliasWithContext is the same as CreateAlias with the addition of the ability to pass a context and additional request options.

See CreateAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) CreateComputer

func (c *DirectoryService) CreateComputer(input *CreateComputerInput) (*CreateComputerOutput, error)

CreateComputer API operation for AWS Directory Service.

Creates a computer account in the specified directory, and joins the computer to the directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation CreateComputer for usage and error information.

Returned Error Codes:

  • ErrCodeAuthenticationFailedException "AuthenticationFailedException" An authentication error occurred.

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The specified entity already exists.

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateComputer

func (*DirectoryService) CreateComputerRequest

func (c *DirectoryService) CreateComputerRequest(input *CreateComputerInput) (req *request.Request, output *CreateComputerOutput)

CreateComputerRequest generates a "aws/request.Request" representing the client's request for the CreateComputer operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateComputer for more information on using the CreateComputer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateComputerRequest method.
req, resp := client.CreateComputerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateComputer

func (*DirectoryService) CreateComputerWithContext added in v1.8.0

func (c *DirectoryService) CreateComputerWithContext(ctx aws.Context, input *CreateComputerInput, opts ...request.Option) (*CreateComputerOutput, error)

CreateComputerWithContext is the same as CreateComputer with the addition of the ability to pass a context and additional request options.

See CreateComputer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) CreateConditionalForwarder added in v1.1.17

CreateConditionalForwarder API operation for AWS Directory Service.

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation CreateConditionalForwarder for usage and error information.

Returned Error Codes:

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The specified entity already exists.

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateConditionalForwarder

func (*DirectoryService) CreateConditionalForwarderRequest added in v1.1.17

func (c *DirectoryService) CreateConditionalForwarderRequest(input *CreateConditionalForwarderInput) (req *request.Request, output *CreateConditionalForwarderOutput)

CreateConditionalForwarderRequest generates a "aws/request.Request" representing the client's request for the CreateConditionalForwarder operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConditionalForwarder for more information on using the CreateConditionalForwarder API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateConditionalForwarderRequest method.
req, resp := client.CreateConditionalForwarderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateConditionalForwarder

func (*DirectoryService) CreateConditionalForwarderWithContext added in v1.8.0

func (c *DirectoryService) CreateConditionalForwarderWithContext(ctx aws.Context, input *CreateConditionalForwarderInput, opts ...request.Option) (*CreateConditionalForwarderOutput, error)

CreateConditionalForwarderWithContext is the same as CreateConditionalForwarder with the addition of the ability to pass a context and additional request options.

See CreateConditionalForwarder for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) CreateDirectory

func (c *DirectoryService) CreateDirectory(input *CreateDirectoryInput) (*CreateDirectoryOutput, error)

CreateDirectory API operation for AWS Directory Service.

Creates a Simple AD directory.

Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation CreateDirectory for usage and error information.

Returned Error Codes:

  • ErrCodeDirectoryLimitExceededException "DirectoryLimitExceededException" The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateDirectory

func (*DirectoryService) CreateDirectoryRequest

func (c *DirectoryService) CreateDirectoryRequest(input *CreateDirectoryInput) (req *request.Request, output *CreateDirectoryOutput)

CreateDirectoryRequest generates a "aws/request.Request" representing the client's request for the CreateDirectory operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDirectory for more information on using the CreateDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDirectoryRequest method.
req, resp := client.CreateDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateDirectory

func (*DirectoryService) CreateDirectoryWithContext added in v1.8.0

func (c *DirectoryService) CreateDirectoryWithContext(ctx aws.Context, input *CreateDirectoryInput, opts ...request.Option) (*CreateDirectoryOutput, error)

CreateDirectoryWithContext is the same as CreateDirectory with the addition of the ability to pass a context and additional request options.

See CreateDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) CreateMicrosoftAD added in v1.0.3

func (c *DirectoryService) CreateMicrosoftAD(input *CreateMicrosoftADInput) (*CreateMicrosoftADOutput, error)

CreateMicrosoftAD API operation for AWS Directory Service.

Creates a Microsoft AD in the AWS cloud.

Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation CreateMicrosoftAD for usage and error information.

Returned Error Codes:

  • ErrCodeDirectoryLimitExceededException "DirectoryLimitExceededException" The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateMicrosoftAD

func (*DirectoryService) CreateMicrosoftADRequest added in v1.0.3

func (c *DirectoryService) CreateMicrosoftADRequest(input *CreateMicrosoftADInput) (req *request.Request, output *CreateMicrosoftADOutput)

CreateMicrosoftADRequest generates a "aws/request.Request" representing the client's request for the CreateMicrosoftAD operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMicrosoftAD for more information on using the CreateMicrosoftAD API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateMicrosoftADRequest method.
req, resp := client.CreateMicrosoftADRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateMicrosoftAD

func (*DirectoryService) CreateMicrosoftADWithContext added in v1.8.0

func (c *DirectoryService) CreateMicrosoftADWithContext(ctx aws.Context, input *CreateMicrosoftADInput, opts ...request.Option) (*CreateMicrosoftADOutput, error)

CreateMicrosoftADWithContext is the same as CreateMicrosoftAD with the addition of the ability to pass a context and additional request options.

See CreateMicrosoftAD for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) CreateSnapshot

func (c *DirectoryService) CreateSnapshot(input *CreateSnapshotInput) (*CreateSnapshotOutput, error)

CreateSnapshot API operation for AWS Directory Service.

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

You cannot take snapshots of AD Connector directories.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation CreateSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeSnapshotLimitExceededException "SnapshotLimitExceededException" The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateSnapshot

func (*DirectoryService) CreateSnapshotRequest

func (c *DirectoryService) CreateSnapshotRequest(input *CreateSnapshotInput) (req *request.Request, output *CreateSnapshotOutput)

CreateSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSnapshot for more information on using the CreateSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSnapshotRequest method.
req, resp := client.CreateSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateSnapshot

func (*DirectoryService) CreateSnapshotWithContext added in v1.8.0

func (c *DirectoryService) CreateSnapshotWithContext(ctx aws.Context, input *CreateSnapshotInput, opts ...request.Option) (*CreateSnapshotOutput, error)

CreateSnapshotWithContext is the same as CreateSnapshot with the addition of the ability to pass a context and additional request options.

See CreateSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) CreateTrust added in v1.0.3

func (c *DirectoryService) CreateTrust(input *CreateTrustInput) (*CreateTrustOutput, error)

CreateTrust API operation for AWS Directory Service.

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation CreateTrust for usage and error information.

Returned Error Codes:

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The specified entity already exists.

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateTrust

func (*DirectoryService) CreateTrustRequest added in v1.0.3

func (c *DirectoryService) CreateTrustRequest(input *CreateTrustInput) (req *request.Request, output *CreateTrustOutput)

CreateTrustRequest generates a "aws/request.Request" representing the client's request for the CreateTrust operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTrust for more information on using the CreateTrust API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateTrustRequest method.
req, resp := client.CreateTrustRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CreateTrust

func (*DirectoryService) CreateTrustWithContext added in v1.8.0

func (c *DirectoryService) CreateTrustWithContext(ctx aws.Context, input *CreateTrustInput, opts ...request.Option) (*CreateTrustOutput, error)

CreateTrustWithContext is the same as CreateTrust with the addition of the ability to pass a context and additional request options.

See CreateTrust for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DeleteConditionalForwarder added in v1.1.17

DeleteConditionalForwarder API operation for AWS Directory Service.

Deletes a conditional forwarder that has been set up for your AWS directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DeleteConditionalForwarder for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteConditionalForwarder

func (*DirectoryService) DeleteConditionalForwarderRequest added in v1.1.17

func (c *DirectoryService) DeleteConditionalForwarderRequest(input *DeleteConditionalForwarderInput) (req *request.Request, output *DeleteConditionalForwarderOutput)

DeleteConditionalForwarderRequest generates a "aws/request.Request" representing the client's request for the DeleteConditionalForwarder operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConditionalForwarder for more information on using the DeleteConditionalForwarder API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteConditionalForwarderRequest method.
req, resp := client.DeleteConditionalForwarderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteConditionalForwarder

func (*DirectoryService) DeleteConditionalForwarderWithContext added in v1.8.0

func (c *DirectoryService) DeleteConditionalForwarderWithContext(ctx aws.Context, input *DeleteConditionalForwarderInput, opts ...request.Option) (*DeleteConditionalForwarderOutput, error)

DeleteConditionalForwarderWithContext is the same as DeleteConditionalForwarder with the addition of the ability to pass a context and additional request options.

See DeleteConditionalForwarder for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DeleteDirectory

func (c *DirectoryService) DeleteDirectory(input *DeleteDirectoryInput) (*DeleteDirectoryOutput, error)

DeleteDirectory API operation for AWS Directory Service.

Deletes an AWS Directory Service directory.

Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DeleteDirectory for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteDirectory

func (*DirectoryService) DeleteDirectoryRequest

func (c *DirectoryService) DeleteDirectoryRequest(input *DeleteDirectoryInput) (req *request.Request, output *DeleteDirectoryOutput)

DeleteDirectoryRequest generates a "aws/request.Request" representing the client's request for the DeleteDirectory operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDirectory for more information on using the DeleteDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDirectoryRequest method.
req, resp := client.DeleteDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteDirectory

func (*DirectoryService) DeleteDirectoryWithContext added in v1.8.0

func (c *DirectoryService) DeleteDirectoryWithContext(ctx aws.Context, input *DeleteDirectoryInput, opts ...request.Option) (*DeleteDirectoryOutput, error)

DeleteDirectoryWithContext is the same as DeleteDirectory with the addition of the ability to pass a context and additional request options.

See DeleteDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DeleteSnapshot

func (c *DirectoryService) DeleteSnapshot(input *DeleteSnapshotInput) (*DeleteSnapshotOutput, error)

DeleteSnapshot API operation for AWS Directory Service.

Deletes a directory snapshot.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DeleteSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteSnapshot

func (*DirectoryService) DeleteSnapshotRequest

func (c *DirectoryService) DeleteSnapshotRequest(input *DeleteSnapshotInput) (req *request.Request, output *DeleteSnapshotOutput)

DeleteSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSnapshot for more information on using the DeleteSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSnapshotRequest method.
req, resp := client.DeleteSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteSnapshot

func (*DirectoryService) DeleteSnapshotWithContext added in v1.8.0

func (c *DirectoryService) DeleteSnapshotWithContext(ctx aws.Context, input *DeleteSnapshotInput, opts ...request.Option) (*DeleteSnapshotOutput, error)

DeleteSnapshotWithContext is the same as DeleteSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DeleteTrust added in v1.0.3

func (c *DirectoryService) DeleteTrust(input *DeleteTrustInput) (*DeleteTrustOutput, error)

DeleteTrust API operation for AWS Directory Service.

Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DeleteTrust for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteTrust

func (*DirectoryService) DeleteTrustRequest added in v1.0.3

func (c *DirectoryService) DeleteTrustRequest(input *DeleteTrustInput) (req *request.Request, output *DeleteTrustOutput)

DeleteTrustRequest generates a "aws/request.Request" representing the client's request for the DeleteTrust operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTrust for more information on using the DeleteTrust API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteTrustRequest method.
req, resp := client.DeleteTrustRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeleteTrust

func (*DirectoryService) DeleteTrustWithContext added in v1.8.0

func (c *DirectoryService) DeleteTrustWithContext(ctx aws.Context, input *DeleteTrustInput, opts ...request.Option) (*DeleteTrustOutput, error)

DeleteTrustWithContext is the same as DeleteTrust with the addition of the ability to pass a context and additional request options.

See DeleteTrust for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DeregisterEventTopic added in v1.1.8

func (c *DirectoryService) DeregisterEventTopic(input *DeregisterEventTopicInput) (*DeregisterEventTopicOutput, error)

DeregisterEventTopic API operation for AWS Directory Service.

Removes the specified directory as a publisher to the specified SNS topic.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DeregisterEventTopic for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeregisterEventTopic

func (*DirectoryService) DeregisterEventTopicRequest added in v1.1.8

func (c *DirectoryService) DeregisterEventTopicRequest(input *DeregisterEventTopicInput) (req *request.Request, output *DeregisterEventTopicOutput)

DeregisterEventTopicRequest generates a "aws/request.Request" representing the client's request for the DeregisterEventTopic operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterEventTopic for more information on using the DeregisterEventTopic API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterEventTopicRequest method.
req, resp := client.DeregisterEventTopicRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DeregisterEventTopic

func (*DirectoryService) DeregisterEventTopicWithContext added in v1.8.0

func (c *DirectoryService) DeregisterEventTopicWithContext(ctx aws.Context, input *DeregisterEventTopicInput, opts ...request.Option) (*DeregisterEventTopicOutput, error)

DeregisterEventTopicWithContext is the same as DeregisterEventTopic with the addition of the ability to pass a context and additional request options.

See DeregisterEventTopic for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DescribeConditionalForwarders added in v1.1.17

DescribeConditionalForwarders API operation for AWS Directory Service.

Obtains information about the conditional forwarders for this account.

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DescribeConditionalForwarders for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeConditionalForwarders

func (*DirectoryService) DescribeConditionalForwardersRequest added in v1.1.17

func (c *DirectoryService) DescribeConditionalForwardersRequest(input *DescribeConditionalForwardersInput) (req *request.Request, output *DescribeConditionalForwardersOutput)

DescribeConditionalForwardersRequest generates a "aws/request.Request" representing the client's request for the DescribeConditionalForwarders operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeConditionalForwarders for more information on using the DescribeConditionalForwarders API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeConditionalForwardersRequest method.
req, resp := client.DescribeConditionalForwardersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeConditionalForwarders

func (*DirectoryService) DescribeConditionalForwardersWithContext added in v1.8.0

func (c *DirectoryService) DescribeConditionalForwardersWithContext(ctx aws.Context, input *DescribeConditionalForwardersInput, opts ...request.Option) (*DescribeConditionalForwardersOutput, error)

DescribeConditionalForwardersWithContext is the same as DescribeConditionalForwarders with the addition of the ability to pass a context and additional request options.

See DescribeConditionalForwarders for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DescribeDirectories

func (c *DirectoryService) DescribeDirectories(input *DescribeDirectoriesInput) (*DescribeDirectoriesOutput, error)

DescribeDirectories API operation for AWS Directory Service.

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DescribeDirectories for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value is not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeDirectories

func (*DirectoryService) DescribeDirectoriesRequest

func (c *DirectoryService) DescribeDirectoriesRequest(input *DescribeDirectoriesInput) (req *request.Request, output *DescribeDirectoriesOutput)

DescribeDirectoriesRequest generates a "aws/request.Request" representing the client's request for the DescribeDirectories operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDirectories for more information on using the DescribeDirectories API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDirectoriesRequest method.
req, resp := client.DescribeDirectoriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeDirectories

func (*DirectoryService) DescribeDirectoriesWithContext added in v1.8.0

func (c *DirectoryService) DescribeDirectoriesWithContext(ctx aws.Context, input *DescribeDirectoriesInput, opts ...request.Option) (*DescribeDirectoriesOutput, error)

DescribeDirectoriesWithContext is the same as DescribeDirectories with the addition of the ability to pass a context and additional request options.

See DescribeDirectories for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DescribeDomainControllers added in v1.10.8

DescribeDomainControllers API operation for AWS Directory Service.

Provides information about any domain controllers in your directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DescribeDomainControllers for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeDomainControllers

func (*DirectoryService) DescribeDomainControllersPages added in v1.10.8

func (c *DirectoryService) DescribeDomainControllersPages(input *DescribeDomainControllersInput, fn func(*DescribeDomainControllersOutput, bool) bool) error

DescribeDomainControllersPages iterates over the pages of a DescribeDomainControllers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDomainControllers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDomainControllers operation.
pageNum := 0
err := client.DescribeDomainControllersPages(params,
    func(page *DescribeDomainControllersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DirectoryService) DescribeDomainControllersPagesWithContext added in v1.10.8

func (c *DirectoryService) DescribeDomainControllersPagesWithContext(ctx aws.Context, input *DescribeDomainControllersInput, fn func(*DescribeDomainControllersOutput, bool) bool, opts ...request.Option) error

DescribeDomainControllersPagesWithContext same as DescribeDomainControllersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DescribeDomainControllersRequest added in v1.10.8

func (c *DirectoryService) DescribeDomainControllersRequest(input *DescribeDomainControllersInput) (req *request.Request, output *DescribeDomainControllersOutput)

DescribeDomainControllersRequest generates a "aws/request.Request" representing the client's request for the DescribeDomainControllers operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDomainControllers for more information on using the DescribeDomainControllers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDomainControllersRequest method.
req, resp := client.DescribeDomainControllersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeDomainControllers

func (*DirectoryService) DescribeDomainControllersWithContext added in v1.10.8

func (c *DirectoryService) DescribeDomainControllersWithContext(ctx aws.Context, input *DescribeDomainControllersInput, opts ...request.Option) (*DescribeDomainControllersOutput, error)

DescribeDomainControllersWithContext is the same as DescribeDomainControllers with the addition of the ability to pass a context and additional request options.

See DescribeDomainControllers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DescribeEventTopics added in v1.1.8

func (c *DirectoryService) DescribeEventTopics(input *DescribeEventTopicsInput) (*DescribeEventTopicsOutput, error)

DescribeEventTopics API operation for AWS Directory Service.

Obtains information about which SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DescribeEventTopics for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeEventTopics

func (*DirectoryService) DescribeEventTopicsRequest added in v1.1.8

func (c *DirectoryService) DescribeEventTopicsRequest(input *DescribeEventTopicsInput) (req *request.Request, output *DescribeEventTopicsOutput)

DescribeEventTopicsRequest generates a "aws/request.Request" representing the client's request for the DescribeEventTopics operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventTopics for more information on using the DescribeEventTopics API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEventTopicsRequest method.
req, resp := client.DescribeEventTopicsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeEventTopics

func (*DirectoryService) DescribeEventTopicsWithContext added in v1.8.0

func (c *DirectoryService) DescribeEventTopicsWithContext(ctx aws.Context, input *DescribeEventTopicsInput, opts ...request.Option) (*DescribeEventTopicsOutput, error)

DescribeEventTopicsWithContext is the same as DescribeEventTopics with the addition of the ability to pass a context and additional request options.

See DescribeEventTopics for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DescribeSnapshots

func (c *DirectoryService) DescribeSnapshots(input *DescribeSnapshotsInput) (*DescribeSnapshotsOutput, error)

DescribeSnapshots API operation for AWS Directory Service.

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DescribeSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value is not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeSnapshots

func (*DirectoryService) DescribeSnapshotsRequest

func (c *DirectoryService) DescribeSnapshotsRequest(input *DescribeSnapshotsInput) (req *request.Request, output *DescribeSnapshotsOutput)

DescribeSnapshotsRequest generates a "aws/request.Request" representing the client's request for the DescribeSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSnapshots for more information on using the DescribeSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSnapshotsRequest method.
req, resp := client.DescribeSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeSnapshots

func (*DirectoryService) DescribeSnapshotsWithContext added in v1.8.0

func (c *DirectoryService) DescribeSnapshotsWithContext(ctx aws.Context, input *DescribeSnapshotsInput, opts ...request.Option) (*DescribeSnapshotsOutput, error)

DescribeSnapshotsWithContext is the same as DescribeSnapshots with the addition of the ability to pass a context and additional request options.

See DescribeSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DescribeTrusts added in v1.0.3

func (c *DirectoryService) DescribeTrusts(input *DescribeTrustsInput) (*DescribeTrustsOutput, error)

DescribeTrusts API operation for AWS Directory Service.

Obtains information about the trust relationships for this account.

If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DescribeTrusts for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeTrusts

func (*DirectoryService) DescribeTrustsRequest added in v1.0.3

func (c *DirectoryService) DescribeTrustsRequest(input *DescribeTrustsInput) (req *request.Request, output *DescribeTrustsOutput)

DescribeTrustsRequest generates a "aws/request.Request" representing the client's request for the DescribeTrusts operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTrusts for more information on using the DescribeTrusts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeTrustsRequest method.
req, resp := client.DescribeTrustsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeTrusts

func (*DirectoryService) DescribeTrustsWithContext added in v1.8.0

func (c *DirectoryService) DescribeTrustsWithContext(ctx aws.Context, input *DescribeTrustsInput, opts ...request.Option) (*DescribeTrustsOutput, error)

DescribeTrustsWithContext is the same as DescribeTrusts with the addition of the ability to pass a context and additional request options.

See DescribeTrusts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DisableRadius

func (c *DirectoryService) DisableRadius(input *DisableRadiusInput) (*DisableRadiusOutput, error)

DisableRadius API operation for AWS Directory Service.

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DisableRadius for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DisableRadius

func (*DirectoryService) DisableRadiusRequest

func (c *DirectoryService) DisableRadiusRequest(input *DisableRadiusInput) (req *request.Request, output *DisableRadiusOutput)

DisableRadiusRequest generates a "aws/request.Request" representing the client's request for the DisableRadius operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableRadius for more information on using the DisableRadius API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisableRadiusRequest method.
req, resp := client.DisableRadiusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DisableRadius

func (*DirectoryService) DisableRadiusWithContext added in v1.8.0

func (c *DirectoryService) DisableRadiusWithContext(ctx aws.Context, input *DisableRadiusInput, opts ...request.Option) (*DisableRadiusOutput, error)

DisableRadiusWithContext is the same as DisableRadius with the addition of the ability to pass a context and additional request options.

See DisableRadius for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) DisableSso added in v0.9.5

func (c *DirectoryService) DisableSso(input *DisableSsoInput) (*DisableSsoOutput, error)

DisableSso API operation for AWS Directory Service.

Disables single-sign on for a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation DisableSso for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInsufficientPermissionsException "InsufficientPermissionsException" The account does not have sufficient permission to perform the operation.

  • ErrCodeAuthenticationFailedException "AuthenticationFailedException" An authentication error occurred.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DisableSso

func (*DirectoryService) DisableSsoRequest added in v0.9.5

func (c *DirectoryService) DisableSsoRequest(input *DisableSsoInput) (req *request.Request, output *DisableSsoOutput)

DisableSsoRequest generates a "aws/request.Request" representing the client's request for the DisableSso operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableSso for more information on using the DisableSso API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisableSsoRequest method.
req, resp := client.DisableSsoRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DisableSso

func (*DirectoryService) DisableSsoWithContext added in v1.8.0

func (c *DirectoryService) DisableSsoWithContext(ctx aws.Context, input *DisableSsoInput, opts ...request.Option) (*DisableSsoOutput, error)

DisableSsoWithContext is the same as DisableSso with the addition of the ability to pass a context and additional request options.

See DisableSso for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) EnableRadius

func (c *DirectoryService) EnableRadius(input *EnableRadiusInput) (*EnableRadiusOutput, error)

EnableRadius API operation for AWS Directory Service.

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation EnableRadius for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeEntityAlreadyExistsException "EntityAlreadyExistsException" The specified entity already exists.

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/EnableRadius

func (*DirectoryService) EnableRadiusRequest

func (c *DirectoryService) EnableRadiusRequest(input *EnableRadiusInput) (req *request.Request, output *EnableRadiusOutput)

EnableRadiusRequest generates a "aws/request.Request" representing the client's request for the EnableRadius operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableRadius for more information on using the EnableRadius API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnableRadiusRequest method.
req, resp := client.EnableRadiusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/EnableRadius

func (*DirectoryService) EnableRadiusWithContext added in v1.8.0

func (c *DirectoryService) EnableRadiusWithContext(ctx aws.Context, input *EnableRadiusInput, opts ...request.Option) (*EnableRadiusOutput, error)

EnableRadiusWithContext is the same as EnableRadius with the addition of the ability to pass a context and additional request options.

See EnableRadius for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) EnableSso added in v0.9.5

func (c *DirectoryService) EnableSso(input *EnableSsoInput) (*EnableSsoOutput, error)

EnableSso API operation for AWS Directory Service.

Enables single sign-on for a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation EnableSso for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInsufficientPermissionsException "InsufficientPermissionsException" The account does not have sufficient permission to perform the operation.

  • ErrCodeAuthenticationFailedException "AuthenticationFailedException" An authentication error occurred.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/EnableSso

func (*DirectoryService) EnableSsoRequest added in v0.9.5

func (c *DirectoryService) EnableSsoRequest(input *EnableSsoInput) (req *request.Request, output *EnableSsoOutput)

EnableSsoRequest generates a "aws/request.Request" representing the client's request for the EnableSso operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableSso for more information on using the EnableSso API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnableSsoRequest method.
req, resp := client.EnableSsoRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/EnableSso

func (*DirectoryService) EnableSsoWithContext added in v1.8.0

func (c *DirectoryService) EnableSsoWithContext(ctx aws.Context, input *EnableSsoInput, opts ...request.Option) (*EnableSsoOutput, error)

EnableSsoWithContext is the same as EnableSso with the addition of the ability to pass a context and additional request options.

See EnableSso for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) GetDirectoryLimits

func (c *DirectoryService) GetDirectoryLimits(input *GetDirectoryLimitsInput) (*GetDirectoryLimitsOutput, error)

GetDirectoryLimits API operation for AWS Directory Service.

Obtains directory limit information for the current region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation GetDirectoryLimits for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/GetDirectoryLimits

func (*DirectoryService) GetDirectoryLimitsRequest

func (c *DirectoryService) GetDirectoryLimitsRequest(input *GetDirectoryLimitsInput) (req *request.Request, output *GetDirectoryLimitsOutput)

GetDirectoryLimitsRequest generates a "aws/request.Request" representing the client's request for the GetDirectoryLimits operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDirectoryLimits for more information on using the GetDirectoryLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDirectoryLimitsRequest method.
req, resp := client.GetDirectoryLimitsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/GetDirectoryLimits

func (*DirectoryService) GetDirectoryLimitsWithContext added in v1.8.0

func (c *DirectoryService) GetDirectoryLimitsWithContext(ctx aws.Context, input *GetDirectoryLimitsInput, opts ...request.Option) (*GetDirectoryLimitsOutput, error)

GetDirectoryLimitsWithContext is the same as GetDirectoryLimits with the addition of the ability to pass a context and additional request options.

See GetDirectoryLimits for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) GetSnapshotLimits

func (c *DirectoryService) GetSnapshotLimits(input *GetSnapshotLimitsInput) (*GetSnapshotLimitsOutput, error)

GetSnapshotLimits API operation for AWS Directory Service.

Obtains the manual snapshot limits for a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation GetSnapshotLimits for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/GetSnapshotLimits

func (*DirectoryService) GetSnapshotLimitsRequest

func (c *DirectoryService) GetSnapshotLimitsRequest(input *GetSnapshotLimitsInput) (req *request.Request, output *GetSnapshotLimitsOutput)

GetSnapshotLimitsRequest generates a "aws/request.Request" representing the client's request for the GetSnapshotLimits operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSnapshotLimits for more information on using the GetSnapshotLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSnapshotLimitsRequest method.
req, resp := client.GetSnapshotLimitsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/GetSnapshotLimits

func (*DirectoryService) GetSnapshotLimitsWithContext added in v1.8.0

func (c *DirectoryService) GetSnapshotLimitsWithContext(ctx aws.Context, input *GetSnapshotLimitsInput, opts ...request.Option) (*GetSnapshotLimitsOutput, error)

GetSnapshotLimitsWithContext is the same as GetSnapshotLimits with the addition of the ability to pass a context and additional request options.

See GetSnapshotLimits for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) ListIpRoutes added in v1.2.10

func (c *DirectoryService) ListIpRoutes(input *ListIpRoutesInput) (*ListIpRoutesOutput, error)

ListIpRoutes API operation for AWS Directory Service.

Lists the address blocks that you have added to a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation ListIpRoutes for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListIpRoutes

func (*DirectoryService) ListIpRoutesRequest added in v1.2.10

func (c *DirectoryService) ListIpRoutesRequest(input *ListIpRoutesInput) (req *request.Request, output *ListIpRoutesOutput)

ListIpRoutesRequest generates a "aws/request.Request" representing the client's request for the ListIpRoutes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIpRoutes for more information on using the ListIpRoutes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListIpRoutesRequest method.
req, resp := client.ListIpRoutesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListIpRoutes

func (*DirectoryService) ListIpRoutesWithContext added in v1.8.0

func (c *DirectoryService) ListIpRoutesWithContext(ctx aws.Context, input *ListIpRoutesInput, opts ...request.Option) (*ListIpRoutesOutput, error)

ListIpRoutesWithContext is the same as ListIpRoutes with the addition of the ability to pass a context and additional request options.

See ListIpRoutes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) ListSchemaExtensions added in v1.5.5

func (c *DirectoryService) ListSchemaExtensions(input *ListSchemaExtensionsInput) (*ListSchemaExtensionsOutput, error)

ListSchemaExtensions API operation for AWS Directory Service.

Lists all schema extensions applied to a Microsoft AD Directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation ListSchemaExtensions for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value is not valid.

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListSchemaExtensions

func (*DirectoryService) ListSchemaExtensionsRequest added in v1.5.5

func (c *DirectoryService) ListSchemaExtensionsRequest(input *ListSchemaExtensionsInput) (req *request.Request, output *ListSchemaExtensionsOutput)

ListSchemaExtensionsRequest generates a "aws/request.Request" representing the client's request for the ListSchemaExtensions operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSchemaExtensions for more information on using the ListSchemaExtensions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSchemaExtensionsRequest method.
req, resp := client.ListSchemaExtensionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListSchemaExtensions

func (*DirectoryService) ListSchemaExtensionsWithContext added in v1.8.0

func (c *DirectoryService) ListSchemaExtensionsWithContext(ctx aws.Context, input *ListSchemaExtensionsInput, opts ...request.Option) (*ListSchemaExtensionsOutput, error)

ListSchemaExtensionsWithContext is the same as ListSchemaExtensions with the addition of the ability to pass a context and additional request options.

See ListSchemaExtensions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) ListTagsForResource added in v1.2.4

func (c *DirectoryService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Directory Service.

Lists all tags on a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value is not valid.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListTagsForResource

func (*DirectoryService) ListTagsForResourceRequest added in v1.2.4

func (c *DirectoryService) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListTagsForResource

func (*DirectoryService) ListTagsForResourceWithContext added in v1.8.0

func (c *DirectoryService) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) RegisterEventTopic added in v1.1.8

func (c *DirectoryService) RegisterEventTopic(input *RegisterEventTopicInput) (*RegisterEventTopicOutput, error)

RegisterEventTopic API operation for AWS Directory Service.

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation RegisterEventTopic for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/RegisterEventTopic

func (*DirectoryService) RegisterEventTopicRequest added in v1.1.8

func (c *DirectoryService) RegisterEventTopicRequest(input *RegisterEventTopicInput) (req *request.Request, output *RegisterEventTopicOutput)

RegisterEventTopicRequest generates a "aws/request.Request" representing the client's request for the RegisterEventTopic operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterEventTopic for more information on using the RegisterEventTopic API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterEventTopicRequest method.
req, resp := client.RegisterEventTopicRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/RegisterEventTopic

func (*DirectoryService) RegisterEventTopicWithContext added in v1.8.0

func (c *DirectoryService) RegisterEventTopicWithContext(ctx aws.Context, input *RegisterEventTopicInput, opts ...request.Option) (*RegisterEventTopicOutput, error)

RegisterEventTopicWithContext is the same as RegisterEventTopic with the addition of the ability to pass a context and additional request options.

See RegisterEventTopic for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) RemoveIpRoutes added in v1.2.10

func (c *DirectoryService) RemoveIpRoutes(input *RemoveIpRoutesInput) (*RemoveIpRoutesOutput, error)

RemoveIpRoutes API operation for AWS Directory Service.

Removes IP address blocks from a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation RemoveIpRoutes for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/RemoveIpRoutes

func (*DirectoryService) RemoveIpRoutesRequest added in v1.2.10

func (c *DirectoryService) RemoveIpRoutesRequest(input *RemoveIpRoutesInput) (req *request.Request, output *RemoveIpRoutesOutput)

RemoveIpRoutesRequest generates a "aws/request.Request" representing the client's request for the RemoveIpRoutes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveIpRoutes for more information on using the RemoveIpRoutes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveIpRoutesRequest method.
req, resp := client.RemoveIpRoutesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/RemoveIpRoutes

func (*DirectoryService) RemoveIpRoutesWithContext added in v1.8.0

func (c *DirectoryService) RemoveIpRoutesWithContext(ctx aws.Context, input *RemoveIpRoutesInput, opts ...request.Option) (*RemoveIpRoutesOutput, error)

RemoveIpRoutesWithContext is the same as RemoveIpRoutes with the addition of the ability to pass a context and additional request options.

See RemoveIpRoutes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) RemoveTagsFromResource added in v1.2.4

RemoveTagsFromResource API operation for AWS Directory Service.

Removes tags from a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation RemoveTagsFromResource for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/RemoveTagsFromResource

func (*DirectoryService) RemoveTagsFromResourceRequest added in v1.2.4

func (c *DirectoryService) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *RemoveTagsFromResourceOutput)

RemoveTagsFromResourceRequest generates a "aws/request.Request" representing the client's request for the RemoveTagsFromResource operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTagsFromResource for more information on using the RemoveTagsFromResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveTagsFromResourceRequest method.
req, resp := client.RemoveTagsFromResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/RemoveTagsFromResource

func (*DirectoryService) RemoveTagsFromResourceWithContext added in v1.8.0

func (c *DirectoryService) RemoveTagsFromResourceWithContext(ctx aws.Context, input *RemoveTagsFromResourceInput, opts ...request.Option) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResourceWithContext is the same as RemoveTagsFromResource with the addition of the ability to pass a context and additional request options.

See RemoveTagsFromResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) ResetUserPassword added in v1.13.60

func (c *DirectoryService) ResetUserPassword(input *ResetUserPasswordInput) (*ResetUserPasswordOutput, error)

ResetUserPassword API operation for AWS Directory Service.

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation ResetUserPassword for usage and error information.

Returned Error Codes:

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeUserDoesNotExistException "UserDoesNotExistException" The user provided a username that does not exist in your directory.

  • ErrCodeInvalidPasswordException "InvalidPasswordException" The new password provided by the user does not meet the password complexity requirements defined in your directory.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ResetUserPassword

func (*DirectoryService) ResetUserPasswordRequest added in v1.13.60

func (c *DirectoryService) ResetUserPasswordRequest(input *ResetUserPasswordInput) (req *request.Request, output *ResetUserPasswordOutput)

ResetUserPasswordRequest generates a "aws/request.Request" representing the client's request for the ResetUserPassword operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResetUserPassword for more information on using the ResetUserPassword API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ResetUserPasswordRequest method.
req, resp := client.ResetUserPasswordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ResetUserPassword

func (*DirectoryService) ResetUserPasswordWithContext added in v1.13.60

func (c *DirectoryService) ResetUserPasswordWithContext(ctx aws.Context, input *ResetUserPasswordInput, opts ...request.Option) (*ResetUserPasswordOutput, error)

ResetUserPasswordWithContext is the same as ResetUserPassword with the addition of the ability to pass a context and additional request options.

See ResetUserPassword for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) RestoreFromSnapshot

func (c *DirectoryService) RestoreFromSnapshot(input *RestoreFromSnapshotInput) (*RestoreFromSnapshotOutput, error)

RestoreFromSnapshot API operation for AWS Directory Service.

Restores a directory using an existing directory snapshot.

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation RestoreFromSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/RestoreFromSnapshot

func (*DirectoryService) RestoreFromSnapshotRequest

func (c *DirectoryService) RestoreFromSnapshotRequest(input *RestoreFromSnapshotInput) (req *request.Request, output *RestoreFromSnapshotOutput)

RestoreFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the RestoreFromSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreFromSnapshot for more information on using the RestoreFromSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RestoreFromSnapshotRequest method.
req, resp := client.RestoreFromSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/RestoreFromSnapshot

func (*DirectoryService) RestoreFromSnapshotWithContext added in v1.8.0

func (c *DirectoryService) RestoreFromSnapshotWithContext(ctx aws.Context, input *RestoreFromSnapshotInput, opts ...request.Option) (*RestoreFromSnapshotOutput, error)

RestoreFromSnapshotWithContext is the same as RestoreFromSnapshot with the addition of the ability to pass a context and additional request options.

See RestoreFromSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) StartSchemaExtension added in v1.5.5

func (c *DirectoryService) StartSchemaExtension(input *StartSchemaExtensionInput) (*StartSchemaExtensionOutput, error)

StartSchemaExtension API operation for AWS Directory Service.

Applies a schema extension to a Microsoft AD directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation StartSchemaExtension for usage and error information.

Returned Error Codes:

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeSnapshotLimitExceededException "SnapshotLimitExceededException" The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/StartSchemaExtension

func (*DirectoryService) StartSchemaExtensionRequest added in v1.5.5

func (c *DirectoryService) StartSchemaExtensionRequest(input *StartSchemaExtensionInput) (req *request.Request, output *StartSchemaExtensionOutput)

StartSchemaExtensionRequest generates a "aws/request.Request" representing the client's request for the StartSchemaExtension operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartSchemaExtension for more information on using the StartSchemaExtension API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartSchemaExtensionRequest method.
req, resp := client.StartSchemaExtensionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/StartSchemaExtension

func (*DirectoryService) StartSchemaExtensionWithContext added in v1.8.0

func (c *DirectoryService) StartSchemaExtensionWithContext(ctx aws.Context, input *StartSchemaExtensionInput, opts ...request.Option) (*StartSchemaExtensionOutput, error)

StartSchemaExtensionWithContext is the same as StartSchemaExtension with the addition of the ability to pass a context and additional request options.

See StartSchemaExtension for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) UpdateConditionalForwarder added in v1.1.17

UpdateConditionalForwarder API operation for AWS Directory Service.

Updates a conditional forwarder that has been set up for your AWS directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation UpdateConditionalForwarder for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateConditionalForwarder

func (*DirectoryService) UpdateConditionalForwarderRequest added in v1.1.17

func (c *DirectoryService) UpdateConditionalForwarderRequest(input *UpdateConditionalForwarderInput) (req *request.Request, output *UpdateConditionalForwarderOutput)

UpdateConditionalForwarderRequest generates a "aws/request.Request" representing the client's request for the UpdateConditionalForwarder operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConditionalForwarder for more information on using the UpdateConditionalForwarder API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateConditionalForwarderRequest method.
req, resp := client.UpdateConditionalForwarderRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateConditionalForwarder

func (*DirectoryService) UpdateConditionalForwarderWithContext added in v1.8.0

func (c *DirectoryService) UpdateConditionalForwarderWithContext(ctx aws.Context, input *UpdateConditionalForwarderInput, opts ...request.Option) (*UpdateConditionalForwarderOutput, error)

UpdateConditionalForwarderWithContext is the same as UpdateConditionalForwarder with the addition of the ability to pass a context and additional request options.

See UpdateConditionalForwarder for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) UpdateNumberOfDomainControllers added in v1.10.8

UpdateNumberOfDomainControllers API operation for AWS Directory Service.

Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation UpdateNumberOfDomainControllers for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeDirectoryUnavailableException "DirectoryUnavailableException" The specified directory is unavailable or could not be found.

  • ErrCodeDomainControllerLimitExceededException "DomainControllerLimitExceededException" The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateNumberOfDomainControllers

func (*DirectoryService) UpdateNumberOfDomainControllersRequest added in v1.10.8

func (c *DirectoryService) UpdateNumberOfDomainControllersRequest(input *UpdateNumberOfDomainControllersInput) (req *request.Request, output *UpdateNumberOfDomainControllersOutput)

UpdateNumberOfDomainControllersRequest generates a "aws/request.Request" representing the client's request for the UpdateNumberOfDomainControllers operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateNumberOfDomainControllers for more information on using the UpdateNumberOfDomainControllers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateNumberOfDomainControllersRequest method.
req, resp := client.UpdateNumberOfDomainControllersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateNumberOfDomainControllers

func (*DirectoryService) UpdateNumberOfDomainControllersWithContext added in v1.10.8

func (c *DirectoryService) UpdateNumberOfDomainControllersWithContext(ctx aws.Context, input *UpdateNumberOfDomainControllersInput, opts ...request.Option) (*UpdateNumberOfDomainControllersOutput, error)

UpdateNumberOfDomainControllersWithContext is the same as UpdateNumberOfDomainControllers with the addition of the ability to pass a context and additional request options.

See UpdateNumberOfDomainControllers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) UpdateRadius

func (c *DirectoryService) UpdateRadius(input *UpdateRadiusInput) (*UpdateRadiusOutput, error)

UpdateRadius API operation for AWS Directory Service.

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation UpdateRadius for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateRadius

func (*DirectoryService) UpdateRadiusRequest

func (c *DirectoryService) UpdateRadiusRequest(input *UpdateRadiusInput) (req *request.Request, output *UpdateRadiusOutput)

UpdateRadiusRequest generates a "aws/request.Request" representing the client's request for the UpdateRadius operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRadius for more information on using the UpdateRadius API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRadiusRequest method.
req, resp := client.UpdateRadiusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/UpdateRadius

func (*DirectoryService) UpdateRadiusWithContext added in v1.8.0

func (c *DirectoryService) UpdateRadiusWithContext(ctx aws.Context, input *UpdateRadiusInput, opts ...request.Option) (*UpdateRadiusOutput, error)

UpdateRadiusWithContext is the same as UpdateRadius with the addition of the ability to pass a context and additional request options.

See UpdateRadius for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DirectoryService) VerifyTrust added in v1.0.3

func (c *DirectoryService) VerifyTrust(input *VerifyTrustInput) (*VerifyTrustOutput, error)

VerifyTrust API operation for AWS Directory Service.

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Directory Service's API operation VerifyTrust for usage and error information.

Returned Error Codes:

  • ErrCodeEntityDoesNotExistException "EntityDoesNotExistException" The specified entity could not be found.

  • ErrCodeInvalidParameterException "InvalidParameterException" One or more parameters are not valid.

  • ErrCodeClientException "ClientException" A client exception has occurred.

  • ErrCodeServiceException "ServiceException" An exception has occurred in AWS Directory Service.

  • ErrCodeUnsupportedOperationException "UnsupportedOperationException" The operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/VerifyTrust

func (*DirectoryService) VerifyTrustRequest added in v1.0.3

func (c *DirectoryService) VerifyTrustRequest(input *VerifyTrustInput) (req *request.Request, output *VerifyTrustOutput)

VerifyTrustRequest generates a "aws/request.Request" representing the client's request for the VerifyTrust operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See VerifyTrust for more information on using the VerifyTrust API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the VerifyTrustRequest method.
req, resp := client.VerifyTrustRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/VerifyTrust

func (*DirectoryService) VerifyTrustWithContext added in v1.8.0

func (c *DirectoryService) VerifyTrustWithContext(ctx aws.Context, input *VerifyTrustInput, opts ...request.Option) (*VerifyTrustOutput, error)

VerifyTrustWithContext is the same as VerifyTrust with the addition of the ability to pass a context and additional request options.

See VerifyTrust for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type DirectoryVpcSettings added in v0.9.5

type DirectoryVpcSettings struct {

	// The identifiers of the subnets for the directory servers. The two subnets
	// must be in different Availability Zones. AWS Directory Service creates a
	// directory server and a DNS server in each of these subnets.
	//
	// SubnetIds is a required field
	SubnetIds []*string `type:"list" required:"true"`

	// The identifier of the VPC in which to create the directory.
	//
	// VpcId is a required field
	VpcId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

func (DirectoryVpcSettings) GoString added in v0.9.5

func (s DirectoryVpcSettings) GoString() string

GoString returns the string representation

func (*DirectoryVpcSettings) SetSubnetIds added in v1.5.0

func (s *DirectoryVpcSettings) SetSubnetIds(v []*string) *DirectoryVpcSettings

SetSubnetIds sets the SubnetIds field's value.

func (*DirectoryVpcSettings) SetVpcId added in v1.5.0

SetVpcId sets the VpcId field's value.

func (DirectoryVpcSettings) String added in v0.9.5

func (s DirectoryVpcSettings) String() string

String returns the string representation

func (*DirectoryVpcSettings) Validate added in v1.1.21

func (s *DirectoryVpcSettings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DirectoryVpcSettingsDescription added in v0.9.5

type DirectoryVpcSettingsDescription struct {

	// The list of Availability Zones that the directory is in.
	AvailabilityZones []*string `type:"list"`

	// The domain controller security group identifier for the directory.
	SecurityGroupId *string `type:"string"`

	// The identifiers of the subnets for the directory servers.
	SubnetIds []*string `type:"list"`

	// The identifier of the VPC that the directory is in.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the directory.

func (DirectoryVpcSettingsDescription) GoString added in v0.9.5

GoString returns the string representation

func (*DirectoryVpcSettingsDescription) SetAvailabilityZones added in v1.5.0

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*DirectoryVpcSettingsDescription) SetSecurityGroupId added in v1.5.0

SetSecurityGroupId sets the SecurityGroupId field's value.

func (*DirectoryVpcSettingsDescription) SetSubnetIds added in v1.5.0

SetSubnetIds sets the SubnetIds field's value.

func (*DirectoryVpcSettingsDescription) SetVpcId added in v1.5.0

SetVpcId sets the VpcId field's value.

func (DirectoryVpcSettingsDescription) String added in v0.9.5

String returns the string representation

type DisableRadiusInput

type DisableRadiusInput struct {

	// The identifier of the directory for which to disable MFA.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the DisableRadius operation.

func (DisableRadiusInput) GoString added in v0.6.5

func (s DisableRadiusInput) GoString() string

GoString returns the string representation

func (*DisableRadiusInput) SetDirectoryId added in v1.5.0

func (s *DisableRadiusInput) SetDirectoryId(v string) *DisableRadiusInput

SetDirectoryId sets the DirectoryId field's value.

func (DisableRadiusInput) String added in v0.6.5

func (s DisableRadiusInput) String() string

String returns the string representation

func (*DisableRadiusInput) Validate added in v1.1.21

func (s *DisableRadiusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisableRadiusOutput

type DisableRadiusOutput struct {
	// contains filtered or unexported fields
}

Contains the results of the DisableRadius operation.

func (DisableRadiusOutput) GoString added in v0.6.5

func (s DisableRadiusOutput) GoString() string

GoString returns the string representation

func (DisableRadiusOutput) String added in v0.6.5

func (s DisableRadiusOutput) String() string

String returns the string representation

type DisableSsoInput added in v0.9.5

type DisableSsoInput struct {

	// The identifier of the directory for which to disable single-sign on.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The password of an alternate account to use to disable single-sign on. This
	// is only used for AD Connector directories. For more information, see the
	// UserName parameter.
	Password *string `min:"1" type:"string"`

	// The username of an alternate account to use to disable single-sign on. This
	// is only used for AD Connector directories. This account must have privileges
	// to remove a service principal name.
	//
	// If the AD Connector service account does not have privileges to remove a
	// service principal name, you can specify an alternate account with the UserName
	// and Password parameters. These credentials are only used to disable single
	// sign-on and are not stored by the service. The AD Connector service account
	// is not changed.
	UserName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the DisableSso operation.

func (DisableSsoInput) GoString added in v0.9.5

func (s DisableSsoInput) GoString() string

GoString returns the string representation

func (*DisableSsoInput) SetDirectoryId added in v1.5.0

func (s *DisableSsoInput) SetDirectoryId(v string) *DisableSsoInput

SetDirectoryId sets the DirectoryId field's value.

func (*DisableSsoInput) SetPassword added in v1.5.0

func (s *DisableSsoInput) SetPassword(v string) *DisableSsoInput

SetPassword sets the Password field's value.

func (*DisableSsoInput) SetUserName added in v1.5.0

func (s *DisableSsoInput) SetUserName(v string) *DisableSsoInput

SetUserName sets the UserName field's value.

func (DisableSsoInput) String added in v0.9.5

func (s DisableSsoInput) String() string

String returns the string representation

func (*DisableSsoInput) Validate added in v1.1.21

func (s *DisableSsoInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisableSsoOutput added in v0.9.5

type DisableSsoOutput struct {
	// contains filtered or unexported fields
}

Contains the results of the DisableSso operation.

func (DisableSsoOutput) GoString added in v0.9.5

func (s DisableSsoOutput) GoString() string

GoString returns the string representation

func (DisableSsoOutput) String added in v0.9.5

func (s DisableSsoOutput) String() string

String returns the string representation

type DomainController added in v1.10.8

type DomainController struct {

	// The Availability Zone where the domain controller is located.
	AvailabilityZone *string `type:"string"`

	// Identifier of the directory where the domain controller resides.
	DirectoryId *string `type:"string"`

	// The IP address of the domain controller.
	DnsIpAddr *string `type:"string"`

	// Identifies a specific domain controller in the directory.
	DomainControllerId *string `type:"string"`

	// Specifies when the domain controller was created.
	LaunchTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The status of the domain controller.
	Status *string `type:"string" enum:"DomainControllerStatus"`

	// The date and time that the status was last updated.
	StatusLastUpdatedDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// A description of the domain controller state.
	StatusReason *string `type:"string"`

	// Identifier of the subnet in the VPC that contains the domain controller.
	SubnetId *string `type:"string"`

	// The identifier of the VPC that contains the domain controller.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the domain controllers for a specified directory.

func (DomainController) GoString added in v1.10.8

func (s DomainController) GoString() string

GoString returns the string representation

func (*DomainController) SetAvailabilityZone added in v1.10.8

func (s *DomainController) SetAvailabilityZone(v string) *DomainController

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*DomainController) SetDirectoryId added in v1.10.8

func (s *DomainController) SetDirectoryId(v string) *DomainController

SetDirectoryId sets the DirectoryId field's value.

func (*DomainController) SetDnsIpAddr added in v1.10.8

func (s *DomainController) SetDnsIpAddr(v string) *DomainController

SetDnsIpAddr sets the DnsIpAddr field's value.

func (*DomainController) SetDomainControllerId added in v1.10.8

func (s *DomainController) SetDomainControllerId(v string) *DomainController

SetDomainControllerId sets the DomainControllerId field's value.

func (*DomainController) SetLaunchTime added in v1.10.8

func (s *DomainController) SetLaunchTime(v time.Time) *DomainController

SetLaunchTime sets the LaunchTime field's value.

func (*DomainController) SetStatus added in v1.10.8

func (s *DomainController) SetStatus(v string) *DomainController

SetStatus sets the Status field's value.

func (*DomainController) SetStatusLastUpdatedDateTime added in v1.10.8

func (s *DomainController) SetStatusLastUpdatedDateTime(v time.Time) *DomainController

SetStatusLastUpdatedDateTime sets the StatusLastUpdatedDateTime field's value.

func (*DomainController) SetStatusReason added in v1.10.8

func (s *DomainController) SetStatusReason(v string) *DomainController

SetStatusReason sets the StatusReason field's value.

func (*DomainController) SetSubnetId added in v1.10.8

func (s *DomainController) SetSubnetId(v string) *DomainController

SetSubnetId sets the SubnetId field's value.

func (*DomainController) SetVpcId added in v1.10.8

func (s *DomainController) SetVpcId(v string) *DomainController

SetVpcId sets the VpcId field's value.

func (DomainController) String added in v1.10.8

func (s DomainController) String() string

String returns the string representation

type EnableRadiusInput

type EnableRadiusInput struct {

	// The identifier of the directory for which to enable MFA.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// A RadiusSettings object that contains information about the RADIUS server.
	//
	// RadiusSettings is a required field
	RadiusSettings *RadiusSettings `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the EnableRadius operation.

func (EnableRadiusInput) GoString added in v0.6.5

func (s EnableRadiusInput) GoString() string

GoString returns the string representation

func (*EnableRadiusInput) SetDirectoryId added in v1.5.0

func (s *EnableRadiusInput) SetDirectoryId(v string) *EnableRadiusInput

SetDirectoryId sets the DirectoryId field's value.

func (*EnableRadiusInput) SetRadiusSettings added in v1.5.0

func (s *EnableRadiusInput) SetRadiusSettings(v *RadiusSettings) *EnableRadiusInput

SetRadiusSettings sets the RadiusSettings field's value.

func (EnableRadiusInput) String added in v0.6.5

func (s EnableRadiusInput) String() string

String returns the string representation

func (*EnableRadiusInput) Validate added in v1.1.21

func (s *EnableRadiusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableRadiusOutput

type EnableRadiusOutput struct {
	// contains filtered or unexported fields
}

Contains the results of the EnableRadius operation.

func (EnableRadiusOutput) GoString added in v0.6.5

func (s EnableRadiusOutput) GoString() string

GoString returns the string representation

func (EnableRadiusOutput) String added in v0.6.5

func (s EnableRadiusOutput) String() string

String returns the string representation

type EnableSsoInput added in v0.9.5

type EnableSsoInput struct {

	// The identifier of the directory for which to enable single-sign on.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The password of an alternate account to use to enable single-sign on. This
	// is only used for AD Connector directories. For more information, see the
	// UserName parameter.
	Password *string `min:"1" type:"string"`

	// The username of an alternate account to use to enable single-sign on. This
	// is only used for AD Connector directories. This account must have privileges
	// to add a service principal name.
	//
	// If the AD Connector service account does not have privileges to add a service
	// principal name, you can specify an alternate account with the UserName and
	// Password parameters. These credentials are only used to enable single sign-on
	// and are not stored by the service. The AD Connector service account is not
	// changed.
	UserName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the EnableSso operation.

func (EnableSsoInput) GoString added in v0.9.5

func (s EnableSsoInput) GoString() string

GoString returns the string representation

func (*EnableSsoInput) SetDirectoryId added in v1.5.0

func (s *EnableSsoInput) SetDirectoryId(v string) *EnableSsoInput

SetDirectoryId sets the DirectoryId field's value.

func (*EnableSsoInput) SetPassword added in v1.5.0

func (s *EnableSsoInput) SetPassword(v string) *EnableSsoInput

SetPassword sets the Password field's value.

func (*EnableSsoInput) SetUserName added in v1.5.0

func (s *EnableSsoInput) SetUserName(v string) *EnableSsoInput

SetUserName sets the UserName field's value.

func (EnableSsoInput) String added in v0.9.5

func (s EnableSsoInput) String() string

String returns the string representation

func (*EnableSsoInput) Validate added in v1.1.21

func (s *EnableSsoInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableSsoOutput added in v0.9.5

type EnableSsoOutput struct {
	// contains filtered or unexported fields
}

Contains the results of the EnableSso operation.

func (EnableSsoOutput) GoString added in v0.9.5

func (s EnableSsoOutput) GoString() string

GoString returns the string representation

func (EnableSsoOutput) String added in v0.9.5

func (s EnableSsoOutput) String() string

String returns the string representation

type EventTopic added in v1.1.8

type EventTopic struct {

	// The date and time of when you associated your directory with the SNS topic.
	CreatedDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The Directory ID of an AWS Directory Service directory that will publish
	// status messages to an SNS topic.
	DirectoryId *string `type:"string"`

	// The topic registration status.
	Status *string `type:"string" enum:"TopicStatus"`

	// The SNS topic ARN (Amazon Resource Name).
	TopicArn *string `type:"string"`

	// The name of an AWS SNS topic the receives status messages from the directory.
	TopicName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about SNS topic and AWS Directory Service directory associations.

func (EventTopic) GoString added in v1.1.8

func (s EventTopic) GoString() string

GoString returns the string representation

func (*EventTopic) SetCreatedDateTime added in v1.5.0

func (s *EventTopic) SetCreatedDateTime(v time.Time) *EventTopic

SetCreatedDateTime sets the CreatedDateTime field's value.

func (*EventTopic) SetDirectoryId added in v1.5.0

func (s *EventTopic) SetDirectoryId(v string) *EventTopic

SetDirectoryId sets the DirectoryId field's value.

func (*EventTopic) SetStatus added in v1.5.0

func (s *EventTopic) SetStatus(v string) *EventTopic

SetStatus sets the Status field's value.

func (*EventTopic) SetTopicArn added in v1.5.0

func (s *EventTopic) SetTopicArn(v string) *EventTopic

SetTopicArn sets the TopicArn field's value.

func (*EventTopic) SetTopicName added in v1.5.0

func (s *EventTopic) SetTopicName(v string) *EventTopic

SetTopicName sets the TopicName field's value.

func (EventTopic) String added in v1.1.8

func (s EventTopic) String() string

String returns the string representation

type GetDirectoryLimitsInput

type GetDirectoryLimitsInput struct {
	// contains filtered or unexported fields
}

Contains the inputs for the GetDirectoryLimits operation.

func (GetDirectoryLimitsInput) GoString added in v0.6.5

func (s GetDirectoryLimitsInput) GoString() string

GoString returns the string representation

func (GetDirectoryLimitsInput) String added in v0.6.5

func (s GetDirectoryLimitsInput) String() string

String returns the string representation

type GetDirectoryLimitsOutput

type GetDirectoryLimitsOutput struct {

	// A DirectoryLimits object that contains the directory limits for the current
	// region.
	DirectoryLimits *DirectoryLimits `type:"structure"`
	// contains filtered or unexported fields
}

Contains the results of the GetDirectoryLimits operation.

func (GetDirectoryLimitsOutput) GoString added in v0.6.5

func (s GetDirectoryLimitsOutput) GoString() string

GoString returns the string representation

func (*GetDirectoryLimitsOutput) SetDirectoryLimits added in v1.5.0

SetDirectoryLimits sets the DirectoryLimits field's value.

func (GetDirectoryLimitsOutput) String added in v0.6.5

func (s GetDirectoryLimitsOutput) String() string

String returns the string representation

type GetSnapshotLimitsInput

type GetSnapshotLimitsInput struct {

	// Contains the identifier of the directory to obtain the limits for.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the GetSnapshotLimits operation.

func (GetSnapshotLimitsInput) GoString added in v0.6.5

func (s GetSnapshotLimitsInput) GoString() string

GoString returns the string representation

func (*GetSnapshotLimitsInput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (GetSnapshotLimitsInput) String added in v0.6.5

func (s GetSnapshotLimitsInput) String() string

String returns the string representation

func (*GetSnapshotLimitsInput) Validate added in v1.1.21

func (s *GetSnapshotLimitsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSnapshotLimitsOutput

type GetSnapshotLimitsOutput struct {

	// A SnapshotLimits object that contains the manual snapshot limits for the
	// specified directory.
	SnapshotLimits *SnapshotLimits `type:"structure"`
	// contains filtered or unexported fields
}

Contains the results of the GetSnapshotLimits operation.

func (GetSnapshotLimitsOutput) GoString added in v0.6.5

func (s GetSnapshotLimitsOutput) GoString() string

GoString returns the string representation

func (*GetSnapshotLimitsOutput) SetSnapshotLimits added in v1.5.0

SetSnapshotLimits sets the SnapshotLimits field's value.

func (GetSnapshotLimitsOutput) String added in v0.6.5

func (s GetSnapshotLimitsOutput) String() string

String returns the string representation

type IpRoute added in v1.2.10

type IpRoute struct {

	// IP address block using CIDR format, for example 10.0.0.0/24. This is often
	// the address block of the DNS server used for your on-premises domain. For
	// a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.
	CidrIp *string `type:"string"`

	// Description of the address block.
	Description *string `type:"string"`
	// contains filtered or unexported fields
}

IP address block. This is often the address block of the DNS server used for your on-premises domain.

func (IpRoute) GoString added in v1.2.10

func (s IpRoute) GoString() string

GoString returns the string representation

func (*IpRoute) SetCidrIp added in v1.5.0

func (s *IpRoute) SetCidrIp(v string) *IpRoute

SetCidrIp sets the CidrIp field's value.

func (*IpRoute) SetDescription added in v1.5.0

func (s *IpRoute) SetDescription(v string) *IpRoute

SetDescription sets the Description field's value.

func (IpRoute) String added in v1.2.10

func (s IpRoute) String() string

String returns the string representation

type IpRouteInfo added in v1.2.10

type IpRouteInfo struct {

	// The date and time the address block was added to the directory.
	AddedDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// IP address block in the IpRoute.
	CidrIp *string `type:"string"`

	// Description of the IpRouteInfo.
	Description *string `type:"string"`

	// Identifier (ID) of the directory associated with the IP addresses.
	DirectoryId *string `type:"string"`

	// The status of the IP address block.
	IpRouteStatusMsg *string `type:"string" enum:"IpRouteStatusMsg"`

	// The reason for the IpRouteStatusMsg.
	IpRouteStatusReason *string `type:"string"`
	// contains filtered or unexported fields
}

Information about one or more IP address blocks.

func (IpRouteInfo) GoString added in v1.2.10

func (s IpRouteInfo) GoString() string

GoString returns the string representation

func (*IpRouteInfo) SetAddedDateTime added in v1.5.0

func (s *IpRouteInfo) SetAddedDateTime(v time.Time) *IpRouteInfo

SetAddedDateTime sets the AddedDateTime field's value.

func (*IpRouteInfo) SetCidrIp added in v1.5.0

func (s *IpRouteInfo) SetCidrIp(v string) *IpRouteInfo

SetCidrIp sets the CidrIp field's value.

func (*IpRouteInfo) SetDescription added in v1.5.0

func (s *IpRouteInfo) SetDescription(v string) *IpRouteInfo

SetDescription sets the Description field's value.

func (*IpRouteInfo) SetDirectoryId added in v1.5.0

func (s *IpRouteInfo) SetDirectoryId(v string) *IpRouteInfo

SetDirectoryId sets the DirectoryId field's value.

func (*IpRouteInfo) SetIpRouteStatusMsg added in v1.5.0

func (s *IpRouteInfo) SetIpRouteStatusMsg(v string) *IpRouteInfo

SetIpRouteStatusMsg sets the IpRouteStatusMsg field's value.

func (*IpRouteInfo) SetIpRouteStatusReason added in v1.5.0

func (s *IpRouteInfo) SetIpRouteStatusReason(v string) *IpRouteInfo

SetIpRouteStatusReason sets the IpRouteStatusReason field's value.

func (IpRouteInfo) String added in v1.2.10

func (s IpRouteInfo) String() string

String returns the string representation

type ListIpRoutesInput added in v1.2.10

type ListIpRoutesInput struct {

	// Identifier (ID) of the directory for which you want to retrieve the IP addresses.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// Maximum number of items to return. If this value is zero, the maximum number
	// of items is specified by the limitations of the operation.
	Limit *int64 `type:"integer"`

	// The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass
	// null if this is the first call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListIpRoutesInput) GoString added in v1.2.10

func (s ListIpRoutesInput) GoString() string

GoString returns the string representation

func (*ListIpRoutesInput) SetDirectoryId added in v1.5.0

func (s *ListIpRoutesInput) SetDirectoryId(v string) *ListIpRoutesInput

SetDirectoryId sets the DirectoryId field's value.

func (*ListIpRoutesInput) SetLimit added in v1.5.0

func (s *ListIpRoutesInput) SetLimit(v int64) *ListIpRoutesInput

SetLimit sets the Limit field's value.

func (*ListIpRoutesInput) SetNextToken added in v1.5.0

func (s *ListIpRoutesInput) SetNextToken(v string) *ListIpRoutesInput

SetNextToken sets the NextToken field's value.

func (ListIpRoutesInput) String added in v1.2.10

func (s ListIpRoutesInput) String() string

String returns the string representation

func (*ListIpRoutesInput) Validate added in v1.2.10

func (s *ListIpRoutesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListIpRoutesOutput added in v1.2.10

type ListIpRoutesOutput struct {

	// A list of IpRoutes.
	IpRoutesInfo []*IpRouteInfo `type:"list"`

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to ListIpRoutes to retrieve the next set of
	// items.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListIpRoutesOutput) GoString added in v1.2.10

func (s ListIpRoutesOutput) GoString() string

GoString returns the string representation

func (*ListIpRoutesOutput) SetIpRoutesInfo added in v1.5.0

func (s *ListIpRoutesOutput) SetIpRoutesInfo(v []*IpRouteInfo) *ListIpRoutesOutput

SetIpRoutesInfo sets the IpRoutesInfo field's value.

func (*ListIpRoutesOutput) SetNextToken added in v1.5.0

func (s *ListIpRoutesOutput) SetNextToken(v string) *ListIpRoutesOutput

SetNextToken sets the NextToken field's value.

func (ListIpRoutesOutput) String added in v1.2.10

func (s ListIpRoutesOutput) String() string

String returns the string representation

type ListSchemaExtensionsInput added in v1.5.5

type ListSchemaExtensionsInput struct {

	// The identifier of the directory from which to retrieve the schema extension
	// information.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The maximum number of items to return.
	Limit *int64 `type:"integer"`

	// The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions.
	// Pass null if this is the first call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSchemaExtensionsInput) GoString added in v1.5.5

func (s ListSchemaExtensionsInput) GoString() string

GoString returns the string representation

func (*ListSchemaExtensionsInput) SetDirectoryId added in v1.5.5

SetDirectoryId sets the DirectoryId field's value.

func (*ListSchemaExtensionsInput) SetLimit added in v1.5.5

SetLimit sets the Limit field's value.

func (*ListSchemaExtensionsInput) SetNextToken added in v1.5.5

SetNextToken sets the NextToken field's value.

func (ListSchemaExtensionsInput) String added in v1.5.5

func (s ListSchemaExtensionsInput) String() string

String returns the string representation

func (*ListSchemaExtensionsInput) Validate added in v1.5.5

func (s *ListSchemaExtensionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSchemaExtensionsOutput added in v1.5.5

type ListSchemaExtensionsOutput struct {

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to ListSchemaExtensions to retrieve the next
	// set of items.
	NextToken *string `type:"string"`

	// Information about the schema extensions applied to the directory.
	SchemaExtensionsInfo []*SchemaExtensionInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListSchemaExtensionsOutput) GoString added in v1.5.5

func (s ListSchemaExtensionsOutput) GoString() string

GoString returns the string representation

func (*ListSchemaExtensionsOutput) SetNextToken added in v1.5.5

SetNextToken sets the NextToken field's value.

func (*ListSchemaExtensionsOutput) SetSchemaExtensionsInfo added in v1.5.5

SetSchemaExtensionsInfo sets the SchemaExtensionsInfo field's value.

func (ListSchemaExtensionsOutput) String added in v1.5.5

String returns the string representation

type ListTagsForResourceInput added in v1.2.4

type ListTagsForResourceInput struct {

	// Reserved for future use.
	Limit *int64 `type:"integer"`

	// Reserved for future use.
	NextToken *string `type:"string"`

	// Identifier (ID) of the directory for which you want to retrieve tags.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.2.4

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*ListTagsForResourceInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (ListTagsForResourceInput) String added in v1.2.4

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.2.4

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.2.4

type ListTagsForResourceOutput struct {

	// Reserved for future use.
	NextToken *string `type:"string"`

	// List of tags returned by the ListTagsForResource operation.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.2.4

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.2.4

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type RadiusSettings

type RadiusSettings struct {

	// The protocol specified for your RADIUS endpoints.
	AuthenticationProtocol *string `type:"string" enum:"RadiusAuthenticationProtocol"`

	// Not currently used.
	DisplayLabel *string `min:"1" type:"string"`

	// The port that your RADIUS server is using for communications. Your on-premises
	// network must allow inbound traffic over this port from the AWS Directory
	// Service servers.
	RadiusPort *int64 `min:"1025" type:"integer"`

	// The maximum number of times that communication with the RADIUS server is
	// attempted.
	RadiusRetries *int64 `type:"integer"`

	// An array of strings that contains the IP addresses of the RADIUS server endpoints,
	// or the IP addresses of your RADIUS server load balancer.
	RadiusServers []*string `type:"list"`

	// The amount of time, in seconds, to wait for the RADIUS server to respond.
	RadiusTimeout *int64 `min:"1" type:"integer"`

	// Not currently used.
	SharedSecret *string `min:"8" type:"string"`

	// Not currently used.
	UseSameUsername *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains information about a Remote Authentication Dial In User Service (RADIUS) server.

func (RadiusSettings) GoString added in v0.6.5

func (s RadiusSettings) GoString() string

GoString returns the string representation

func (*RadiusSettings) SetAuthenticationProtocol added in v1.5.0

func (s *RadiusSettings) SetAuthenticationProtocol(v string) *RadiusSettings

SetAuthenticationProtocol sets the AuthenticationProtocol field's value.

func (*RadiusSettings) SetDisplayLabel added in v1.5.0

func (s *RadiusSettings) SetDisplayLabel(v string) *RadiusSettings

SetDisplayLabel sets the DisplayLabel field's value.

func (*RadiusSettings) SetRadiusPort added in v1.5.0

func (s *RadiusSettings) SetRadiusPort(v int64) *RadiusSettings

SetRadiusPort sets the RadiusPort field's value.

func (*RadiusSettings) SetRadiusRetries added in v1.5.0

func (s *RadiusSettings) SetRadiusRetries(v int64) *RadiusSettings

SetRadiusRetries sets the RadiusRetries field's value.

func (*RadiusSettings) SetRadiusServers added in v1.5.0

func (s *RadiusSettings) SetRadiusServers(v []*string) *RadiusSettings

SetRadiusServers sets the RadiusServers field's value.

func (*RadiusSettings) SetRadiusTimeout added in v1.5.0

func (s *RadiusSettings) SetRadiusTimeout(v int64) *RadiusSettings

SetRadiusTimeout sets the RadiusTimeout field's value.

func (*RadiusSettings) SetSharedSecret added in v1.5.0

func (s *RadiusSettings) SetSharedSecret(v string) *RadiusSettings

SetSharedSecret sets the SharedSecret field's value.

func (*RadiusSettings) SetUseSameUsername added in v1.5.0

func (s *RadiusSettings) SetUseSameUsername(v bool) *RadiusSettings

SetUseSameUsername sets the UseSameUsername field's value.

func (RadiusSettings) String added in v0.6.5

func (s RadiusSettings) String() string

String returns the string representation

func (*RadiusSettings) Validate added in v1.1.21

func (s *RadiusSettings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterEventTopicInput added in v1.1.8

type RegisterEventTopicInput struct {

	// The Directory ID that will publish status messages to the SNS topic.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The SNS topic name to which the directory will publish status messages. This
	// SNS topic must be in the same region as the specified Directory ID.
	//
	// TopicName is a required field
	TopicName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Registers a new event topic.

func (RegisterEventTopicInput) GoString added in v1.1.8

func (s RegisterEventTopicInput) GoString() string

GoString returns the string representation

func (*RegisterEventTopicInput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (*RegisterEventTopicInput) SetTopicName added in v1.5.0

SetTopicName sets the TopicName field's value.

func (RegisterEventTopicInput) String added in v1.1.8

func (s RegisterEventTopicInput) String() string

String returns the string representation

func (*RegisterEventTopicInput) Validate added in v1.1.21

func (s *RegisterEventTopicInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterEventTopicOutput added in v1.1.8

type RegisterEventTopicOutput struct {
	// contains filtered or unexported fields
}

The result of a RegisterEventTopic request.

func (RegisterEventTopicOutput) GoString added in v1.1.8

func (s RegisterEventTopicOutput) GoString() string

GoString returns the string representation

func (RegisterEventTopicOutput) String added in v1.1.8

func (s RegisterEventTopicOutput) String() string

String returns the string representation

type RemoveIpRoutesInput added in v1.2.10

type RemoveIpRoutesInput struct {

	// IP address blocks that you want to remove.
	//
	// CidrIps is a required field
	CidrIps []*string `type:"list" required:"true"`

	// Identifier (ID) of the directory from which you want to remove the IP addresses.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveIpRoutesInput) GoString added in v1.2.10

func (s RemoveIpRoutesInput) GoString() string

GoString returns the string representation

func (*RemoveIpRoutesInput) SetCidrIps added in v1.5.0

func (s *RemoveIpRoutesInput) SetCidrIps(v []*string) *RemoveIpRoutesInput

SetCidrIps sets the CidrIps field's value.

func (*RemoveIpRoutesInput) SetDirectoryId added in v1.5.0

func (s *RemoveIpRoutesInput) SetDirectoryId(v string) *RemoveIpRoutesInput

SetDirectoryId sets the DirectoryId field's value.

func (RemoveIpRoutesInput) String added in v1.2.10

func (s RemoveIpRoutesInput) String() string

String returns the string representation

func (*RemoveIpRoutesInput) Validate added in v1.2.10

func (s *RemoveIpRoutesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveIpRoutesOutput added in v1.2.10

type RemoveIpRoutesOutput struct {
	// contains filtered or unexported fields
}

func (RemoveIpRoutesOutput) GoString added in v1.2.10

func (s RemoveIpRoutesOutput) GoString() string

GoString returns the string representation

func (RemoveIpRoutesOutput) String added in v1.2.10

func (s RemoveIpRoutesOutput) String() string

String returns the string representation

type RemoveTagsFromResourceInput added in v1.2.4

type RemoveTagsFromResourceInput struct {

	// Identifier (ID) of the directory from which to remove the tag.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// The tag key (name) of the tag to be removed.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveTagsFromResourceInput) GoString added in v1.2.4

func (s RemoveTagsFromResourceInput) GoString() string

GoString returns the string representation

func (*RemoveTagsFromResourceInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*RemoveTagsFromResourceInput) SetTagKeys added in v1.5.0

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsFromResourceInput) String added in v1.2.4

String returns the string representation

func (*RemoveTagsFromResourceInput) Validate added in v1.2.4

func (s *RemoveTagsFromResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTagsFromResourceOutput added in v1.2.4

type RemoveTagsFromResourceOutput struct {
	// contains filtered or unexported fields
}

func (RemoveTagsFromResourceOutput) GoString added in v1.2.4

func (s RemoveTagsFromResourceOutput) GoString() string

GoString returns the string representation

func (RemoveTagsFromResourceOutput) String added in v1.2.4

String returns the string representation

type ResetUserPasswordInput added in v1.13.60

type ResetUserPasswordInput struct {

	// Identifier of the AWS Managed Microsoft AD or Simple AD directory in which
	// the user resides.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The new password that will be reset.
	//
	// NewPassword is a required field
	NewPassword *string `min:"1" type:"string" required:"true"`

	// The username of the user whose password will be reset.
	//
	// UserName is a required field
	UserName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResetUserPasswordInput) GoString added in v1.13.60

func (s ResetUserPasswordInput) GoString() string

GoString returns the string representation

func (*ResetUserPasswordInput) SetDirectoryId added in v1.13.60

SetDirectoryId sets the DirectoryId field's value.

func (*ResetUserPasswordInput) SetNewPassword added in v1.13.60

SetNewPassword sets the NewPassword field's value.

func (*ResetUserPasswordInput) SetUserName added in v1.13.60

SetUserName sets the UserName field's value.

func (ResetUserPasswordInput) String added in v1.13.60

func (s ResetUserPasswordInput) String() string

String returns the string representation

func (*ResetUserPasswordInput) Validate added in v1.13.60

func (s *ResetUserPasswordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResetUserPasswordOutput added in v1.13.60

type ResetUserPasswordOutput struct {
	// contains filtered or unexported fields
}

func (ResetUserPasswordOutput) GoString added in v1.13.60

func (s ResetUserPasswordOutput) GoString() string

GoString returns the string representation

func (ResetUserPasswordOutput) String added in v1.13.60

func (s ResetUserPasswordOutput) String() string

String returns the string representation

type RestoreFromSnapshotInput

type RestoreFromSnapshotInput struct {

	// The identifier of the snapshot to restore from.
	//
	// SnapshotId is a required field
	SnapshotId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object representing the inputs for the RestoreFromSnapshot operation.

func (RestoreFromSnapshotInput) GoString added in v0.6.5

func (s RestoreFromSnapshotInput) GoString() string

GoString returns the string representation

func (*RestoreFromSnapshotInput) SetSnapshotId added in v1.5.0

SetSnapshotId sets the SnapshotId field's value.

func (RestoreFromSnapshotInput) String added in v0.6.5

func (s RestoreFromSnapshotInput) String() string

String returns the string representation

func (*RestoreFromSnapshotInput) Validate added in v1.1.21

func (s *RestoreFromSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreFromSnapshotOutput

type RestoreFromSnapshotOutput struct {
	// contains filtered or unexported fields
}

Contains the results of the RestoreFromSnapshot operation.

func (RestoreFromSnapshotOutput) GoString added in v0.6.5

func (s RestoreFromSnapshotOutput) GoString() string

GoString returns the string representation

func (RestoreFromSnapshotOutput) String added in v0.6.5

func (s RestoreFromSnapshotOutput) String() string

String returns the string representation

type SchemaExtensionInfo added in v1.5.5

type SchemaExtensionInfo struct {

	// A description of the schema extension.
	Description *string `type:"string"`

	// The identifier of the directory to which the schema extension is applied.
	DirectoryId *string `type:"string"`

	// The date and time that the schema extension was completed.
	EndDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The identifier of the schema extension.
	SchemaExtensionId *string `type:"string"`

	// The current status of the schema extension.
	SchemaExtensionStatus *string `type:"string" enum:"SchemaExtensionStatus"`

	// The reason for the SchemaExtensionStatus.
	SchemaExtensionStatusReason *string `type:"string"`

	// The date and time that the schema extension started being applied to the
	// directory.
	StartDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Information about a schema extension.

func (SchemaExtensionInfo) GoString added in v1.5.5

func (s SchemaExtensionInfo) GoString() string

GoString returns the string representation

func (*SchemaExtensionInfo) SetDescription added in v1.5.5

func (s *SchemaExtensionInfo) SetDescription(v string) *SchemaExtensionInfo

SetDescription sets the Description field's value.

func (*SchemaExtensionInfo) SetDirectoryId added in v1.5.5

func (s *SchemaExtensionInfo) SetDirectoryId(v string) *SchemaExtensionInfo

SetDirectoryId sets the DirectoryId field's value.

func (*SchemaExtensionInfo) SetEndDateTime added in v1.5.5

func (s *SchemaExtensionInfo) SetEndDateTime(v time.Time) *SchemaExtensionInfo

SetEndDateTime sets the EndDateTime field's value.

func (*SchemaExtensionInfo) SetSchemaExtensionId added in v1.5.5

func (s *SchemaExtensionInfo) SetSchemaExtensionId(v string) *SchemaExtensionInfo

SetSchemaExtensionId sets the SchemaExtensionId field's value.

func (*SchemaExtensionInfo) SetSchemaExtensionStatus added in v1.5.5

func (s *SchemaExtensionInfo) SetSchemaExtensionStatus(v string) *SchemaExtensionInfo

SetSchemaExtensionStatus sets the SchemaExtensionStatus field's value.

func (*SchemaExtensionInfo) SetSchemaExtensionStatusReason added in v1.5.5

func (s *SchemaExtensionInfo) SetSchemaExtensionStatusReason(v string) *SchemaExtensionInfo

SetSchemaExtensionStatusReason sets the SchemaExtensionStatusReason field's value.

func (*SchemaExtensionInfo) SetStartDateTime added in v1.5.5

func (s *SchemaExtensionInfo) SetStartDateTime(v time.Time) *SchemaExtensionInfo

SetStartDateTime sets the StartDateTime field's value.

func (SchemaExtensionInfo) String added in v1.5.5

func (s SchemaExtensionInfo) String() string

String returns the string representation

type Snapshot

type Snapshot struct {

	// The directory identifier.
	DirectoryId *string `type:"string"`

	// The descriptive name of the snapshot.
	Name *string `type:"string"`

	// The snapshot identifier.
	SnapshotId *string `type:"string"`

	// The date and time that the snapshot was taken.
	StartTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The snapshot status.
	Status *string `type:"string" enum:"SnapshotStatus"`

	// The snapshot type.
	Type *string `type:"string" enum:"SnapshotType"`
	// contains filtered or unexported fields
}

Describes a directory snapshot.

func (Snapshot) GoString added in v0.6.5

func (s Snapshot) GoString() string

GoString returns the string representation

func (*Snapshot) SetDirectoryId added in v1.5.0

func (s *Snapshot) SetDirectoryId(v string) *Snapshot

SetDirectoryId sets the DirectoryId field's value.

func (*Snapshot) SetName added in v1.5.0

func (s *Snapshot) SetName(v string) *Snapshot

SetName sets the Name field's value.

func (*Snapshot) SetSnapshotId added in v1.5.0

func (s *Snapshot) SetSnapshotId(v string) *Snapshot

SetSnapshotId sets the SnapshotId field's value.

func (*Snapshot) SetStartTime added in v1.5.0

func (s *Snapshot) SetStartTime(v time.Time) *Snapshot

SetStartTime sets the StartTime field's value.

func (*Snapshot) SetStatus added in v1.5.0

func (s *Snapshot) SetStatus(v string) *Snapshot

SetStatus sets the Status field's value.

func (*Snapshot) SetType added in v1.5.0

func (s *Snapshot) SetType(v string) *Snapshot

SetType sets the Type field's value.

func (Snapshot) String added in v0.6.5

func (s Snapshot) String() string

String returns the string representation

type SnapshotLimits

type SnapshotLimits struct {

	// The current number of manual snapshots of the directory.
	ManualSnapshotsCurrentCount *int64 `type:"integer"`

	// The maximum number of manual snapshots allowed.
	ManualSnapshotsLimit *int64 `type:"integer"`

	// Indicates if the manual snapshot limit has been reached.
	ManualSnapshotsLimitReached *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains manual snapshot limit information for a directory.

func (SnapshotLimits) GoString added in v0.6.5

func (s SnapshotLimits) GoString() string

GoString returns the string representation

func (*SnapshotLimits) SetManualSnapshotsCurrentCount added in v1.5.0

func (s *SnapshotLimits) SetManualSnapshotsCurrentCount(v int64) *SnapshotLimits

SetManualSnapshotsCurrentCount sets the ManualSnapshotsCurrentCount field's value.

func (*SnapshotLimits) SetManualSnapshotsLimit added in v1.5.0

func (s *SnapshotLimits) SetManualSnapshotsLimit(v int64) *SnapshotLimits

SetManualSnapshotsLimit sets the ManualSnapshotsLimit field's value.

func (*SnapshotLimits) SetManualSnapshotsLimitReached added in v1.5.0

func (s *SnapshotLimits) SetManualSnapshotsLimitReached(v bool) *SnapshotLimits

SetManualSnapshotsLimitReached sets the ManualSnapshotsLimitReached field's value.

func (SnapshotLimits) String added in v0.6.5

func (s SnapshotLimits) String() string

String returns the string representation

type StartSchemaExtensionInput added in v1.5.5

type StartSchemaExtensionInput struct {

	// If true, creates a snapshot of the directory before applying the schema extension.
	//
	// CreateSnapshotBeforeSchemaExtension is a required field
	CreateSnapshotBeforeSchemaExtension *bool `type:"boolean" required:"true"`

	// A description of the schema extension.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The identifier of the directory for which the schema extension will be applied
	// to.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The LDIF file represented as a string. To construct the LdifContent string,
	// precede each line as it would be formatted in an ldif file with \n. See the
	// example request below for more details. The file size can be no larger than
	// 1MB.
	//
	// LdifContent is a required field
	LdifContent *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartSchemaExtensionInput) GoString added in v1.5.5

func (s StartSchemaExtensionInput) GoString() string

GoString returns the string representation

func (*StartSchemaExtensionInput) SetCreateSnapshotBeforeSchemaExtension added in v1.5.5

func (s *StartSchemaExtensionInput) SetCreateSnapshotBeforeSchemaExtension(v bool) *StartSchemaExtensionInput

SetCreateSnapshotBeforeSchemaExtension sets the CreateSnapshotBeforeSchemaExtension field's value.

func (*StartSchemaExtensionInput) SetDescription added in v1.5.5

SetDescription sets the Description field's value.

func (*StartSchemaExtensionInput) SetDirectoryId added in v1.5.5

SetDirectoryId sets the DirectoryId field's value.

func (*StartSchemaExtensionInput) SetLdifContent added in v1.5.5

SetLdifContent sets the LdifContent field's value.

func (StartSchemaExtensionInput) String added in v1.5.5

func (s StartSchemaExtensionInput) String() string

String returns the string representation

func (*StartSchemaExtensionInput) Validate added in v1.5.5

func (s *StartSchemaExtensionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSchemaExtensionOutput added in v1.5.5

type StartSchemaExtensionOutput struct {

	// The identifier of the schema extension that will be applied.
	SchemaExtensionId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartSchemaExtensionOutput) GoString added in v1.5.5

func (s StartSchemaExtensionOutput) GoString() string

GoString returns the string representation

func (*StartSchemaExtensionOutput) SetSchemaExtensionId added in v1.5.5

func (s *StartSchemaExtensionOutput) SetSchemaExtensionId(v string) *StartSchemaExtensionOutput

SetSchemaExtensionId sets the SchemaExtensionId field's value.

func (StartSchemaExtensionOutput) String added in v1.5.5

String returns the string representation

type Tag added in v1.2.4

type Tag struct {

	// Required name of the tag. The string value can be Unicode characters and
	// cannot be prefixed with "aws:". The string can contain only the set of Unicode
	// letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The optional value of the tag. The string value can be Unicode characters.
	// The string can contain only the set of Unicode letters, digits, white-space,
	// '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Metadata assigned to a directory consisting of a key-value pair.

func (Tag) GoString added in v1.2.4

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.5.0

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.2.4

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.2.4

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Trust added in v1.0.3

type Trust struct {

	// The date and time that the trust relationship was created.
	CreatedDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The Directory ID of the AWS directory involved in the trust relationship.
	DirectoryId *string `type:"string"`

	// The date and time that the trust relationship was last updated.
	LastUpdatedDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The Fully Qualified Domain Name (FQDN) of the external domain involved in
	// the trust relationship.
	RemoteDomainName *string `type:"string"`

	// The date and time that the TrustState was last updated.
	StateLastUpdatedDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The trust relationship direction.
	TrustDirection *string `type:"string" enum:"TrustDirection"`

	// The unique ID of the trust relationship.
	TrustId *string `type:"string"`

	// The trust relationship state.
	TrustState *string `type:"string" enum:"TrustState"`

	// The reason for the TrustState.
	TrustStateReason *string `type:"string"`

	// The trust relationship type.
	TrustType *string `type:"string" enum:"TrustType"`
	// contains filtered or unexported fields
}

Describes a trust relationship between an Microsoft AD in the AWS cloud and an external domain.

func (Trust) GoString added in v1.0.3

func (s Trust) GoString() string

GoString returns the string representation

func (*Trust) SetCreatedDateTime added in v1.5.0

func (s *Trust) SetCreatedDateTime(v time.Time) *Trust

SetCreatedDateTime sets the CreatedDateTime field's value.

func (*Trust) SetDirectoryId added in v1.5.0

func (s *Trust) SetDirectoryId(v string) *Trust

SetDirectoryId sets the DirectoryId field's value.

func (*Trust) SetLastUpdatedDateTime added in v1.5.0

func (s *Trust) SetLastUpdatedDateTime(v time.Time) *Trust

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*Trust) SetRemoteDomainName added in v1.5.0

func (s *Trust) SetRemoteDomainName(v string) *Trust

SetRemoteDomainName sets the RemoteDomainName field's value.

func (*Trust) SetStateLastUpdatedDateTime added in v1.5.0

func (s *Trust) SetStateLastUpdatedDateTime(v time.Time) *Trust

SetStateLastUpdatedDateTime sets the StateLastUpdatedDateTime field's value.

func (*Trust) SetTrustDirection added in v1.5.0

func (s *Trust) SetTrustDirection(v string) *Trust

SetTrustDirection sets the TrustDirection field's value.

func (*Trust) SetTrustId added in v1.5.0

func (s *Trust) SetTrustId(v string) *Trust

SetTrustId sets the TrustId field's value.

func (*Trust) SetTrustState added in v1.5.0

func (s *Trust) SetTrustState(v string) *Trust

SetTrustState sets the TrustState field's value.

func (*Trust) SetTrustStateReason added in v1.5.0

func (s *Trust) SetTrustStateReason(v string) *Trust

SetTrustStateReason sets the TrustStateReason field's value.

func (*Trust) SetTrustType added in v1.5.0

func (s *Trust) SetTrustType(v string) *Trust

SetTrustType sets the TrustType field's value.

func (Trust) String added in v1.0.3

func (s Trust) String() string

String returns the string representation

type UpdateConditionalForwarderInput added in v1.1.17

type UpdateConditionalForwarderInput struct {

	// The directory ID of the AWS directory for which to update the conditional
	// forwarder.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// The updated IP addresses of the remote DNS server associated with the conditional
	// forwarder.
	//
	// DnsIpAddrs is a required field
	DnsIpAddrs []*string `type:"list" required:"true"`

	// The fully qualified domain name (FQDN) of the remote domain with which you
	// will set up a trust relationship.
	//
	// RemoteDomainName is a required field
	RemoteDomainName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Updates a conditional forwarder.

func (UpdateConditionalForwarderInput) GoString added in v1.1.17

GoString returns the string representation

func (*UpdateConditionalForwarderInput) SetDirectoryId added in v1.5.0

SetDirectoryId sets the DirectoryId field's value.

func (*UpdateConditionalForwarderInput) SetDnsIpAddrs added in v1.5.0

SetDnsIpAddrs sets the DnsIpAddrs field's value.

func (*UpdateConditionalForwarderInput) SetRemoteDomainName added in v1.5.0

SetRemoteDomainName sets the RemoteDomainName field's value.

func (UpdateConditionalForwarderInput) String added in v1.1.17

String returns the string representation

func (*UpdateConditionalForwarderInput) Validate added in v1.1.21

func (s *UpdateConditionalForwarderInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConditionalForwarderOutput added in v1.1.17

type UpdateConditionalForwarderOutput struct {
	// contains filtered or unexported fields
}

The result of an UpdateConditionalForwarder request.

func (UpdateConditionalForwarderOutput) GoString added in v1.1.17

GoString returns the string representation

func (UpdateConditionalForwarderOutput) String added in v1.1.17

String returns the string representation

type UpdateNumberOfDomainControllersInput added in v1.10.8

type UpdateNumberOfDomainControllersInput struct {

	// The number of domain controllers desired in the directory.
	//
	// DesiredNumber is a required field
	DesiredNumber *int64 `min:"2" type:"integer" required:"true"`

	// Identifier of the directory to which the domain controllers will be added
	// or removed.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateNumberOfDomainControllersInput) GoString added in v1.10.8

GoString returns the string representation

func (*UpdateNumberOfDomainControllersInput) SetDesiredNumber added in v1.10.8

SetDesiredNumber sets the DesiredNumber field's value.

func (*UpdateNumberOfDomainControllersInput) SetDirectoryId added in v1.10.8

SetDirectoryId sets the DirectoryId field's value.

func (UpdateNumberOfDomainControllersInput) String added in v1.10.8

String returns the string representation

func (*UpdateNumberOfDomainControllersInput) Validate added in v1.10.8

Validate inspects the fields of the type to determine if they are valid.

type UpdateNumberOfDomainControllersOutput added in v1.10.8

type UpdateNumberOfDomainControllersOutput struct {
	// contains filtered or unexported fields
}

func (UpdateNumberOfDomainControllersOutput) GoString added in v1.10.8

GoString returns the string representation

func (UpdateNumberOfDomainControllersOutput) String added in v1.10.8

String returns the string representation

type UpdateRadiusInput

type UpdateRadiusInput struct {

	// The identifier of the directory for which to update the RADIUS server information.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// A RadiusSettings object that contains information about the RADIUS server.
	//
	// RadiusSettings is a required field
	RadiusSettings *RadiusSettings `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the UpdateRadius operation.

func (UpdateRadiusInput) GoString added in v0.6.5

func (s UpdateRadiusInput) GoString() string

GoString returns the string representation

func (*UpdateRadiusInput) SetDirectoryId added in v1.5.0

func (s *UpdateRadiusInput) SetDirectoryId(v string) *UpdateRadiusInput

SetDirectoryId sets the DirectoryId field's value.

func (*UpdateRadiusInput) SetRadiusSettings added in v1.5.0

func (s *UpdateRadiusInput) SetRadiusSettings(v *RadiusSettings) *UpdateRadiusInput

SetRadiusSettings sets the RadiusSettings field's value.

func (UpdateRadiusInput) String added in v0.6.5

func (s UpdateRadiusInput) String() string

String returns the string representation

func (*UpdateRadiusInput) Validate added in v1.1.21

func (s *UpdateRadiusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateRadiusOutput

type UpdateRadiusOutput struct {
	// contains filtered or unexported fields
}

Contains the results of the UpdateRadius operation.

func (UpdateRadiusOutput) GoString added in v0.6.5

func (s UpdateRadiusOutput) GoString() string

GoString returns the string representation

func (UpdateRadiusOutput) String added in v0.6.5

func (s UpdateRadiusOutput) String() string

String returns the string representation

type VerifyTrustInput added in v1.0.3

type VerifyTrustInput struct {

	// The unique Trust ID of the trust relationship to verify.
	//
	// TrustId is a required field
	TrustId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and an external domain.

func (VerifyTrustInput) GoString added in v1.0.3

func (s VerifyTrustInput) GoString() string

GoString returns the string representation

func (*VerifyTrustInput) SetTrustId added in v1.5.0

func (s *VerifyTrustInput) SetTrustId(v string) *VerifyTrustInput

SetTrustId sets the TrustId field's value.

func (VerifyTrustInput) String added in v1.0.3

func (s VerifyTrustInput) String() string

String returns the string representation

func (*VerifyTrustInput) Validate added in v1.1.21

func (s *VerifyTrustInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type VerifyTrustOutput added in v1.0.3

type VerifyTrustOutput struct {

	// The unique Trust ID of the trust relationship that was verified.
	TrustId *string `type:"string"`
	// contains filtered or unexported fields
}

Result of a VerifyTrust request.

func (VerifyTrustOutput) GoString added in v1.0.3

func (s VerifyTrustOutput) GoString() string

GoString returns the string representation

func (*VerifyTrustOutput) SetTrustId added in v1.5.0

func (s *VerifyTrustOutput) SetTrustId(v string) *VerifyTrustOutput

SetTrustId sets the TrustId field's value.

func (VerifyTrustOutput) String added in v1.0.3

func (s VerifyTrustOutput) String() string

String returns the string representation

Directories

Path Synopsis
Package directoryserviceiface provides an interface to enable mocking the AWS Directory Service service client for testing your code.
Package directoryserviceiface provides an interface to enable mocking the AWS Directory Service service client for testing your code.

Jump to

Keyboard shortcuts

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