Documentation ¶
Overview ¶
Package directoryservice provides a client for AWS Directory Service.
Index ¶
- Constants
- type AddIpRoutesInput
- type AddIpRoutesOutput
- type AddTagsToResourceInput
- type AddTagsToResourceOutput
- type Attribute
- type Computer
- type ConditionalForwarder
- type ConnectDirectoryInput
- type ConnectDirectoryOutput
- type CreateAliasInput
- type CreateAliasOutput
- type CreateComputerInput
- type CreateComputerOutput
- type CreateConditionalForwarderInput
- type CreateConditionalForwarderOutput
- type CreateDirectoryInput
- type CreateDirectoryOutput
- type CreateMicrosoftADInput
- type CreateMicrosoftADOutput
- type CreateSnapshotInput
- type CreateSnapshotOutput
- type CreateTrustInput
- type CreateTrustOutput
- type DeleteConditionalForwarderInput
- type DeleteConditionalForwarderOutput
- type DeleteDirectoryInput
- type DeleteDirectoryOutput
- type DeleteSnapshotInput
- type DeleteSnapshotOutput
- type DeleteTrustInput
- type DeleteTrustOutput
- type DeregisterEventTopicInput
- type DeregisterEventTopicOutput
- type DescribeConditionalForwardersInput
- type DescribeConditionalForwardersOutput
- type DescribeDirectoriesInput
- type DescribeDirectoriesOutput
- type DescribeEventTopicsInput
- type DescribeEventTopicsOutput
- type DescribeSnapshotsInput
- type DescribeSnapshotsOutput
- type DescribeTrustsInput
- type DescribeTrustsOutput
- type DirectoryConnectSettings
- type DirectoryConnectSettingsDescription
- type DirectoryDescription
- type DirectoryLimits
- type DirectoryService
- func (c *DirectoryService) AddIpRoutes(input *AddIpRoutesInput) (*AddIpRoutesOutput, error)
- func (c *DirectoryService) AddIpRoutesRequest(input *AddIpRoutesInput) (req *request.Request, output *AddIpRoutesOutput)
- func (c *DirectoryService) AddTagsToResource(input *AddTagsToResourceInput) (*AddTagsToResourceOutput, error)
- func (c *DirectoryService) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *AddTagsToResourceOutput)
- func (c *DirectoryService) ConnectDirectory(input *ConnectDirectoryInput) (*ConnectDirectoryOutput, error)
- func (c *DirectoryService) ConnectDirectoryRequest(input *ConnectDirectoryInput) (req *request.Request, output *ConnectDirectoryOutput)
- func (c *DirectoryService) CreateAlias(input *CreateAliasInput) (*CreateAliasOutput, error)
- func (c *DirectoryService) CreateAliasRequest(input *CreateAliasInput) (req *request.Request, output *CreateAliasOutput)
- func (c *DirectoryService) CreateComputer(input *CreateComputerInput) (*CreateComputerOutput, error)
- func (c *DirectoryService) CreateComputerRequest(input *CreateComputerInput) (req *request.Request, output *CreateComputerOutput)
- func (c *DirectoryService) CreateConditionalForwarder(input *CreateConditionalForwarderInput) (*CreateConditionalForwarderOutput, error)
- func (c *DirectoryService) CreateConditionalForwarderRequest(input *CreateConditionalForwarderInput) (req *request.Request, output *CreateConditionalForwarderOutput)
- func (c *DirectoryService) CreateDirectory(input *CreateDirectoryInput) (*CreateDirectoryOutput, error)
- func (c *DirectoryService) CreateDirectoryRequest(input *CreateDirectoryInput) (req *request.Request, output *CreateDirectoryOutput)
- func (c *DirectoryService) CreateMicrosoftAD(input *CreateMicrosoftADInput) (*CreateMicrosoftADOutput, error)
- func (c *DirectoryService) CreateMicrosoftADRequest(input *CreateMicrosoftADInput) (req *request.Request, output *CreateMicrosoftADOutput)
- func (c *DirectoryService) CreateSnapshot(input *CreateSnapshotInput) (*CreateSnapshotOutput, error)
- func (c *DirectoryService) CreateSnapshotRequest(input *CreateSnapshotInput) (req *request.Request, output *CreateSnapshotOutput)
- func (c *DirectoryService) CreateTrust(input *CreateTrustInput) (*CreateTrustOutput, error)
- func (c *DirectoryService) CreateTrustRequest(input *CreateTrustInput) (req *request.Request, output *CreateTrustOutput)
- func (c *DirectoryService) DeleteConditionalForwarder(input *DeleteConditionalForwarderInput) (*DeleteConditionalForwarderOutput, error)
- func (c *DirectoryService) DeleteConditionalForwarderRequest(input *DeleteConditionalForwarderInput) (req *request.Request, output *DeleteConditionalForwarderOutput)
- func (c *DirectoryService) DeleteDirectory(input *DeleteDirectoryInput) (*DeleteDirectoryOutput, error)
- func (c *DirectoryService) DeleteDirectoryRequest(input *DeleteDirectoryInput) (req *request.Request, output *DeleteDirectoryOutput)
- func (c *DirectoryService) DeleteSnapshot(input *DeleteSnapshotInput) (*DeleteSnapshotOutput, error)
- func (c *DirectoryService) DeleteSnapshotRequest(input *DeleteSnapshotInput) (req *request.Request, output *DeleteSnapshotOutput)
- func (c *DirectoryService) DeleteTrust(input *DeleteTrustInput) (*DeleteTrustOutput, error)
- func (c *DirectoryService) DeleteTrustRequest(input *DeleteTrustInput) (req *request.Request, output *DeleteTrustOutput)
- func (c *DirectoryService) DeregisterEventTopic(input *DeregisterEventTopicInput) (*DeregisterEventTopicOutput, error)
- func (c *DirectoryService) DeregisterEventTopicRequest(input *DeregisterEventTopicInput) (req *request.Request, output *DeregisterEventTopicOutput)
- func (c *DirectoryService) DescribeConditionalForwarders(input *DescribeConditionalForwardersInput) (*DescribeConditionalForwardersOutput, error)
- func (c *DirectoryService) DescribeConditionalForwardersRequest(input *DescribeConditionalForwardersInput) (req *request.Request, output *DescribeConditionalForwardersOutput)
- func (c *DirectoryService) DescribeDirectories(input *DescribeDirectoriesInput) (*DescribeDirectoriesOutput, error)
- func (c *DirectoryService) DescribeDirectoriesRequest(input *DescribeDirectoriesInput) (req *request.Request, output *DescribeDirectoriesOutput)
- func (c *DirectoryService) DescribeEventTopics(input *DescribeEventTopicsInput) (*DescribeEventTopicsOutput, error)
- func (c *DirectoryService) DescribeEventTopicsRequest(input *DescribeEventTopicsInput) (req *request.Request, output *DescribeEventTopicsOutput)
- func (c *DirectoryService) DescribeSnapshots(input *DescribeSnapshotsInput) (*DescribeSnapshotsOutput, error)
- func (c *DirectoryService) DescribeSnapshotsRequest(input *DescribeSnapshotsInput) (req *request.Request, output *DescribeSnapshotsOutput)
- func (c *DirectoryService) DescribeTrusts(input *DescribeTrustsInput) (*DescribeTrustsOutput, error)
- func (c *DirectoryService) DescribeTrustsRequest(input *DescribeTrustsInput) (req *request.Request, output *DescribeTrustsOutput)
- func (c *DirectoryService) DisableRadius(input *DisableRadiusInput) (*DisableRadiusOutput, error)
- func (c *DirectoryService) DisableRadiusRequest(input *DisableRadiusInput) (req *request.Request, output *DisableRadiusOutput)
- func (c *DirectoryService) DisableSso(input *DisableSsoInput) (*DisableSsoOutput, error)
- func (c *DirectoryService) DisableSsoRequest(input *DisableSsoInput) (req *request.Request, output *DisableSsoOutput)
- func (c *DirectoryService) EnableRadius(input *EnableRadiusInput) (*EnableRadiusOutput, error)
- func (c *DirectoryService) EnableRadiusRequest(input *EnableRadiusInput) (req *request.Request, output *EnableRadiusOutput)
- func (c *DirectoryService) EnableSso(input *EnableSsoInput) (*EnableSsoOutput, error)
- func (c *DirectoryService) EnableSsoRequest(input *EnableSsoInput) (req *request.Request, output *EnableSsoOutput)
- func (c *DirectoryService) GetDirectoryLimits(input *GetDirectoryLimitsInput) (*GetDirectoryLimitsOutput, error)
- func (c *DirectoryService) GetDirectoryLimitsRequest(input *GetDirectoryLimitsInput) (req *request.Request, output *GetDirectoryLimitsOutput)
- func (c *DirectoryService) GetSnapshotLimits(input *GetSnapshotLimitsInput) (*GetSnapshotLimitsOutput, error)
- func (c *DirectoryService) GetSnapshotLimitsRequest(input *GetSnapshotLimitsInput) (req *request.Request, output *GetSnapshotLimitsOutput)
- func (c *DirectoryService) ListIpRoutes(input *ListIpRoutesInput) (*ListIpRoutesOutput, error)
- func (c *DirectoryService) ListIpRoutesRequest(input *ListIpRoutesInput) (req *request.Request, output *ListIpRoutesOutput)
- func (c *DirectoryService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
- func (c *DirectoryService) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
- func (c *DirectoryService) RegisterEventTopic(input *RegisterEventTopicInput) (*RegisterEventTopicOutput, error)
- func (c *DirectoryService) RegisterEventTopicRequest(input *RegisterEventTopicInput) (req *request.Request, output *RegisterEventTopicOutput)
- func (c *DirectoryService) RemoveIpRoutes(input *RemoveIpRoutesInput) (*RemoveIpRoutesOutput, error)
- func (c *DirectoryService) RemoveIpRoutesRequest(input *RemoveIpRoutesInput) (req *request.Request, output *RemoveIpRoutesOutput)
- func (c *DirectoryService) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)
- func (c *DirectoryService) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *RemoveTagsFromResourceOutput)
- func (c *DirectoryService) RestoreFromSnapshot(input *RestoreFromSnapshotInput) (*RestoreFromSnapshotOutput, error)
- func (c *DirectoryService) RestoreFromSnapshotRequest(input *RestoreFromSnapshotInput) (req *request.Request, output *RestoreFromSnapshotOutput)
- func (c *DirectoryService) UpdateConditionalForwarder(input *UpdateConditionalForwarderInput) (*UpdateConditionalForwarderOutput, error)
- func (c *DirectoryService) UpdateConditionalForwarderRequest(input *UpdateConditionalForwarderInput) (req *request.Request, output *UpdateConditionalForwarderOutput)
- func (c *DirectoryService) UpdateRadius(input *UpdateRadiusInput) (*UpdateRadiusOutput, error)
- func (c *DirectoryService) UpdateRadiusRequest(input *UpdateRadiusInput) (req *request.Request, output *UpdateRadiusOutput)
- func (c *DirectoryService) VerifyTrust(input *VerifyTrustInput) (*VerifyTrustOutput, error)
- func (c *DirectoryService) VerifyTrustRequest(input *VerifyTrustInput) (req *request.Request, output *VerifyTrustOutput)
- type DirectoryVpcSettings
- type DirectoryVpcSettingsDescription
- type DisableRadiusInput
- type DisableRadiusOutput
- type DisableSsoInput
- type DisableSsoOutput
- type EnableRadiusInput
- type EnableRadiusOutput
- type EnableSsoInput
- type EnableSsoOutput
- type EventTopic
- type GetDirectoryLimitsInput
- type GetDirectoryLimitsOutput
- type GetSnapshotLimitsInput
- type GetSnapshotLimitsOutput
- type IpRoute
- type IpRouteInfo
- type ListIpRoutesInput
- type ListIpRoutesOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type RadiusSettings
- type RegisterEventTopicInput
- type RegisterEventTopicOutput
- type RemoveIpRoutesInput
- type RemoveIpRoutesOutput
- type RemoveTagsFromResourceInput
- type RemoveTagsFromResourceOutput
- type RestoreFromSnapshotInput
- type RestoreFromSnapshotOutput
- type Snapshot
- type SnapshotLimits
- type Tag
- type Trust
- type UpdateConditionalForwarderInput
- type UpdateConditionalForwarderOutput
- type UpdateRadiusInput
- type UpdateRadiusOutput
- type VerifyTrustInput
- type VerifyTrustOutput
Examples ¶
- DirectoryService.AddIpRoutes
- DirectoryService.AddTagsToResource
- DirectoryService.ConnectDirectory
- DirectoryService.CreateAlias
- DirectoryService.CreateComputer
- DirectoryService.CreateConditionalForwarder
- DirectoryService.CreateDirectory
- DirectoryService.CreateMicrosoftAD
- DirectoryService.CreateSnapshot
- DirectoryService.CreateTrust
- DirectoryService.DeleteConditionalForwarder
- DirectoryService.DeleteDirectory
- DirectoryService.DeleteSnapshot
- DirectoryService.DeleteTrust
- DirectoryService.DeregisterEventTopic
- DirectoryService.DescribeConditionalForwarders
- DirectoryService.DescribeDirectories
- DirectoryService.DescribeEventTopics
- DirectoryService.DescribeSnapshots
- DirectoryService.DescribeTrusts
- DirectoryService.DisableRadius
- DirectoryService.DisableSso
- DirectoryService.EnableRadius
- DirectoryService.EnableSso
- DirectoryService.GetDirectoryLimits
- DirectoryService.GetSnapshotLimits
- DirectoryService.ListIpRoutes
- DirectoryService.ListTagsForResource
- DirectoryService.RegisterEventTopic
- DirectoryService.RemoveIpRoutes
- DirectoryService.RemoveTagsFromResource
- DirectoryService.RestoreFromSnapshot
- DirectoryService.UpdateConditionalForwarder
- DirectoryService.UpdateRadius
- DirectoryService.VerifyTrust
Constants ¶
const ( // DirectorySizeSmall is a DirectorySize enum value DirectorySizeSmall = "Small" // DirectorySizeLarge is a DirectorySize enum value DirectorySizeLarge = "Large" )
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" )
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" )
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" )
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" )
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" )
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" )
const ( // SnapshotTypeAuto is a SnapshotType enum value SnapshotTypeAuto = "Auto" // SnapshotTypeManual is a SnapshotType enum value SnapshotTypeManual = "Manual" )
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" )
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" )
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" )
const (
// ReplicationScopeDomain is a ReplicationScope enum value
ReplicationScopeDomain = "Domain"
)
const ServiceName = "ds"
A ServiceName is the name of the service the client will make API calls to.
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.3.0
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 // // These security rules impact an internal network interface that is not // exposed publicly. UpdateSecurityGroupForDirectoryControllers *bool `type:"boolean"` // contains filtered or unexported fields }
func (AddIpRoutesInput) GoString ¶ added in v1.3.0
func (s AddIpRoutesInput) GoString() string
GoString returns the string representation
func (AddIpRoutesInput) String ¶ added in v1.3.0
func (s AddIpRoutesInput) String() string
String returns the string representation
func (*AddIpRoutesInput) Validate ¶ added in v1.3.0
func (s *AddIpRoutesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddIpRoutesOutput ¶ added in v1.3.0
type AddIpRoutesOutput struct {
// contains filtered or unexported fields
}
func (AddIpRoutesOutput) GoString ¶ added in v1.3.0
func (s AddIpRoutesOutput) GoString() string
GoString returns the string representation
func (AddIpRoutesOutput) String ¶ added in v1.3.0
func (s AddIpRoutesOutput) String() string
String returns the string representation
type AddTagsToResourceInput ¶ added in v1.2.6
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 Amazon Directory Services directory. // // Tags is a required field Tags []*Tag `type:"list" required:"true"` // contains filtered or unexported fields }
func (AddTagsToResourceInput) GoString ¶ added in v1.2.6
func (s AddTagsToResourceInput) GoString() string
GoString returns the string representation
func (AddTagsToResourceInput) String ¶ added in v1.2.6
func (s AddTagsToResourceInput) String() string
String returns the string representation
func (*AddTagsToResourceInput) Validate ¶ added in v1.2.6
func (s *AddTagsToResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddTagsToResourceOutput ¶ added in v1.2.6
type AddTagsToResourceOutput struct {
// contains filtered or unexported fields
}
func (AddTagsToResourceOutput) GoString ¶ added in v1.2.6
func (s AddTagsToResourceOutput) GoString() string
GoString returns the string representation
func (AddTagsToResourceOutput) String ¶ added in v1.2.6
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.
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.
type ConditionalForwarder ¶ added in v1.1.19
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.19
func (s ConditionalForwarder) GoString() string
GoString returns the string representation
func (ConditionalForwarder) String ¶ added in v1.1.19
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.6
func (s ConnectDirectoryInput) GoString() string
GoString returns the string representation
func (ConnectDirectoryInput) String ¶ added in v0.6.6
func (s ConnectDirectoryInput) String() string
String returns the string representation
func (*ConnectDirectoryInput) Validate ¶ added in v1.1.24
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.6
func (s ConnectDirectoryOutput) GoString() string
GoString returns the string representation
func (ConnectDirectoryOutput) String ¶ added in v0.6.6
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.6
func (s CreateAliasInput) GoString() string
GoString returns the string representation
func (CreateAliasInput) String ¶ added in v0.6.6
func (s CreateAliasInput) String() string
String returns the string representation
func (*CreateAliasInput) Validate ¶ added in v1.1.24
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.6
func (s CreateAliasOutput) GoString() string
GoString returns the string representation
func (CreateAliasOutput) String ¶ added in v0.6.6
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.6
func (s CreateComputerInput) GoString() string
GoString returns the string representation
func (CreateComputerInput) String ¶ added in v0.6.6
func (s CreateComputerInput) String() string
String returns the string representation
func (*CreateComputerInput) Validate ¶ added in v1.1.24
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.6
func (s CreateComputerOutput) GoString() string
GoString returns the string representation
func (CreateComputerOutput) String ¶ added in v0.6.6
func (s CreateComputerOutput) String() string
String returns the string representation
type CreateConditionalForwarderInput ¶ added in v1.1.19
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.19
func (s CreateConditionalForwarderInput) GoString() string
GoString returns the string representation
func (CreateConditionalForwarderInput) String ¶ added in v1.1.19
func (s CreateConditionalForwarderInput) String() string
String returns the string representation
func (*CreateConditionalForwarderInput) Validate ¶ added in v1.1.24
func (s *CreateConditionalForwarderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateConditionalForwarderOutput ¶ added in v1.1.19
type CreateConditionalForwarderOutput struct {
// contains filtered or unexported fields
}
The result of a CreateConditinalForwarder request.
func (CreateConditionalForwarderOutput) GoString ¶ added in v1.1.19
func (s CreateConditionalForwarderOutput) GoString() string
GoString returns the string representation
func (CreateConditionalForwarderOutput) String ¶ added in v1.1.19
func (s CreateConditionalForwarderOutput) String() string
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.6
func (s CreateDirectoryInput) GoString() string
GoString returns the string representation
func (CreateDirectoryInput) String ¶ added in v0.6.6
func (s CreateDirectoryInput) String() string
String returns the string representation
func (*CreateDirectoryInput) Validate ¶ added in v1.1.24
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.6
func (s CreateDirectoryOutput) GoString() string
GoString returns the string representation
func (CreateDirectoryOutput) String ¶ added in v0.6.6
func (s CreateDirectoryOutput) String() string
String returns the string representation
type CreateMicrosoftADInput ¶ added in v1.0.5
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"` // 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.5
func (s CreateMicrosoftADInput) GoString() string
GoString returns the string representation
func (CreateMicrosoftADInput) String ¶ added in v1.0.5
func (s CreateMicrosoftADInput) String() string
String returns the string representation
func (*CreateMicrosoftADInput) Validate ¶ added in v1.1.24
func (s *CreateMicrosoftADInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateMicrosoftADOutput ¶ added in v1.0.5
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.5
func (s CreateMicrosoftADOutput) GoString() string
GoString returns the string representation
func (CreateMicrosoftADOutput) String ¶ added in v1.0.5
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.6
func (s CreateSnapshotInput) GoString() string
GoString returns the string representation
func (CreateSnapshotInput) String ¶ added in v0.6.6
func (s CreateSnapshotInput) String() string
String returns the string representation
func (*CreateSnapshotInput) Validate ¶ added in v1.1.24
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.6
func (s CreateSnapshotOutput) GoString() string
GoString returns the string representation
func (CreateSnapshotOutput) String ¶ added in v0.6.6
func (s CreateSnapshotOutput) String() string
String returns the string representation
type CreateTrustInput ¶ added in v1.0.5
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.5
func (s CreateTrustInput) GoString() string
GoString returns the string representation
func (CreateTrustInput) String ¶ added in v1.0.5
func (s CreateTrustInput) String() string
String returns the string representation
func (*CreateTrustInput) Validate ¶ added in v1.1.24
func (s *CreateTrustInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateTrustOutput ¶ added in v1.0.5
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.5
func (s CreateTrustOutput) GoString() string
GoString returns the string representation
func (CreateTrustOutput) String ¶ added in v1.0.5
func (s CreateTrustOutput) String() string
String returns the string representation
type DeleteConditionalForwarderInput ¶ added in v1.1.19
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.19
func (s DeleteConditionalForwarderInput) GoString() string
GoString returns the string representation
func (DeleteConditionalForwarderInput) String ¶ added in v1.1.19
func (s DeleteConditionalForwarderInput) String() string
String returns the string representation
func (*DeleteConditionalForwarderInput) Validate ¶ added in v1.1.24
func (s *DeleteConditionalForwarderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteConditionalForwarderOutput ¶ added in v1.1.19
type DeleteConditionalForwarderOutput struct {
// contains filtered or unexported fields
}
The result of a DeleteConditionalForwarder request.
func (DeleteConditionalForwarderOutput) GoString ¶ added in v1.1.19
func (s DeleteConditionalForwarderOutput) GoString() string
GoString returns the string representation
func (DeleteConditionalForwarderOutput) String ¶ added in v1.1.19
func (s DeleteConditionalForwarderOutput) String() string
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.6
func (s DeleteDirectoryInput) GoString() string
GoString returns the string representation
func (DeleteDirectoryInput) String ¶ added in v0.6.6
func (s DeleteDirectoryInput) String() string
String returns the string representation
func (*DeleteDirectoryInput) Validate ¶ added in v1.1.24
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.6
func (s DeleteDirectoryOutput) GoString() string
GoString returns the string representation
func (DeleteDirectoryOutput) String ¶ added in v0.6.6
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.6
func (s DeleteSnapshotInput) GoString() string
GoString returns the string representation
func (DeleteSnapshotInput) String ¶ added in v0.6.6
func (s DeleteSnapshotInput) String() string
String returns the string representation
func (*DeleteSnapshotInput) Validate ¶ added in v1.1.24
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.6
func (s DeleteSnapshotOutput) GoString() string
GoString returns the string representation
func (DeleteSnapshotOutput) String ¶ added in v0.6.6
func (s DeleteSnapshotOutput) String() string
String returns the string representation
type DeleteTrustInput ¶ added in v1.0.5
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.5
func (s DeleteTrustInput) GoString() string
GoString returns the string representation
func (DeleteTrustInput) String ¶ added in v1.0.5
func (s DeleteTrustInput) String() string
String returns the string representation
func (*DeleteTrustInput) Validate ¶ added in v1.1.24
func (s *DeleteTrustInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTrustOutput ¶ added in v1.0.5
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.5
func (s DeleteTrustOutput) GoString() string
GoString returns the string representation
func (DeleteTrustOutput) String ¶ added in v1.0.5
func (s DeleteTrustOutput) String() string
String returns the string representation
type DeregisterEventTopicInput ¶ added in v1.1.16
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.16
func (s DeregisterEventTopicInput) GoString() string
GoString returns the string representation
func (DeregisterEventTopicInput) String ¶ added in v1.1.16
func (s DeregisterEventTopicInput) String() string
String returns the string representation
func (*DeregisterEventTopicInput) Validate ¶ added in v1.1.24
func (s *DeregisterEventTopicInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterEventTopicOutput ¶ added in v1.1.16
type DeregisterEventTopicOutput struct {
// contains filtered or unexported fields
}
The result of a DeregisterEventTopic request.
func (DeregisterEventTopicOutput) GoString ¶ added in v1.1.16
func (s DeregisterEventTopicOutput) GoString() string
GoString returns the string representation
func (DeregisterEventTopicOutput) String ¶ added in v1.1.16
func (s DeregisterEventTopicOutput) String() string
String returns the string representation
type DescribeConditionalForwardersInput ¶ added in v1.1.19
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.19
func (s DescribeConditionalForwardersInput) GoString() string
GoString returns the string representation
func (DescribeConditionalForwardersInput) String ¶ added in v1.1.19
func (s DescribeConditionalForwardersInput) String() string
String returns the string representation
func (*DescribeConditionalForwardersInput) Validate ¶ added in v1.1.24
func (s *DescribeConditionalForwardersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeConditionalForwardersOutput ¶ added in v1.1.19
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.19
func (s DescribeConditionalForwardersOutput) GoString() string
GoString returns the string representation
func (DescribeConditionalForwardersOutput) String ¶ added in v1.1.19
func (s DescribeConditionalForwardersOutput) String() string
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.6
func (s DescribeDirectoriesInput) GoString() string
GoString returns the string representation
func (DescribeDirectoriesInput) String ¶ added in v0.6.6
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.6
func (s DescribeDirectoriesOutput) GoString() string
GoString returns the string representation
func (DescribeDirectoriesOutput) String ¶ added in v0.6.6
func (s DescribeDirectoriesOutput) String() string
String returns the string representation
type DescribeEventTopicsInput ¶ added in v1.1.16
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.16
func (s DescribeEventTopicsInput) GoString() string
GoString returns the string representation
func (DescribeEventTopicsInput) String ¶ added in v1.1.16
func (s DescribeEventTopicsInput) String() string
String returns the string representation
type DescribeEventTopicsOutput ¶ added in v1.1.16
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.16
func (s DescribeEventTopicsOutput) GoString() string
GoString returns the string representation
func (DescribeEventTopicsOutput) String ¶ added in v1.1.16
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.6
func (s DescribeSnapshotsInput) GoString() string
GoString returns the string representation
func (DescribeSnapshotsInput) String ¶ added in v0.6.6
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.6
func (s DescribeSnapshotsOutput) GoString() string
GoString returns the string representation
func (DescribeSnapshotsOutput) String ¶ added in v0.6.6
func (s DescribeSnapshotsOutput) String() string
String returns the string representation
type DescribeTrustsInput ¶ added in v1.0.5
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.5
func (s DescribeTrustsInput) GoString() string
GoString returns the string representation
func (DescribeTrustsInput) String ¶ added in v1.0.5
func (s DescribeTrustsInput) String() string
String returns the string representation
type DescribeTrustsOutput ¶ added in v1.0.5
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.5
func (s DescribeTrustsOutput) GoString() string
GoString returns the string representation
func (DescribeTrustsOutput) String ¶ added in v1.0.5
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.6
func (s DirectoryConnectSettings) GoString() string
GoString returns the string representation
func (DirectoryConnectSettings) String ¶ added in v0.6.6
func (s DirectoryConnectSettings) String() string
String returns the string representation
func (*DirectoryConnectSettings) Validate ¶ added in v1.1.24
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.6
func (s DirectoryConnectSettingsDescription) GoString() string
GoString returns the string representation
func (DirectoryConnectSettingsDescription) String ¶ added in v0.6.6
func (s DirectoryConnectSettingsDescription) String() string
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 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"` // 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.6
func (s DirectoryDescription) GoString() string
GoString returns the string representation
func (DirectoryDescription) String ¶ added in v0.6.6
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.6
func (s DirectoryLimits) GoString() string
GoString returns the string representation
func (DirectoryLimits) String ¶ added in v0.6.6
func (s DirectoryLimits) String() string
String returns the string representation
type DirectoryService ¶
This is the AWS Directory Service API Reference. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *DirectoryService
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.3.0
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.
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:
EntityDoesNotExistException The specified entity could not be found.
EntityAlreadyExistsException The specified entity already exists.
InvalidParameterException One or more parameters are not valid.
DirectoryUnavailableException The specified directory is unavailable or could not be found.
IpRouteLimitExceededException The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.AddIpRoutesInput{ DirectoryId: aws.String("DirectoryId"), // Required IpRoutes: []*directoryservice.IpRoute{ // Required { // Required CidrIp: aws.String("CidrIp"), Description: aws.String("Description"), }, // More values... }, UpdateSecurityGroupForDirectoryControllers: aws.Bool(true), } resp, err := svc.AddIpRoutes(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) AddIpRoutesRequest ¶ added in v1.3.0
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 can be used to capture response data after the request's "Send" method is called.
See AddIpRoutes for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddIpRoutes method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) AddTagsToResource ¶ added in v1.2.6
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 Amazon Directory Services directory. Each directory can have a maximum of 10 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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
TagLimitExceededException The maximum allowed number of tags was exceeded.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.AddTagsToResourceInput{ ResourceId: aws.String("ResourceId"), // Required Tags: []*directoryservice.Tag{ // Required { // Required Key: aws.String("TagKey"), // Required Value: aws.String("TagValue"), // Required }, // More values... }, } resp, err := svc.AddTagsToResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) AddTagsToResourceRequest ¶ added in v1.2.6
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 can be used to capture response data after the request's "Send" method is called.
See AddTagsToResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddTagsToResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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.
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:
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.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.ConnectDirectoryInput{ ConnectSettings: &directoryservice.DirectoryConnectSettings{ // Required CustomerDnsIps: []*string{ // Required aws.String("IpAddr"), // Required // More values... }, CustomerUserName: aws.String("UserName"), // Required SubnetIds: []*string{ // Required aws.String("SubnetId"), // Required // More values... }, VpcId: aws.String("VpcId"), // Required }, Name: aws.String("DirectoryName"), // Required Password: aws.String("ConnectPassword"), // Required Size: aws.String("DirectorySize"), // Required Description: aws.String("Description"), ShortName: aws.String("DirectoryShortName"), } resp, err := svc.ConnectDirectory(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See ConnectDirectory for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ConnectDirectory method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
EntityAlreadyExistsException The specified entity already exists.
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.CreateAliasInput{ Alias: aws.String("AliasName"), // Required DirectoryId: aws.String("DirectoryId"), // Required } resp, err := svc.CreateAlias(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See CreateAlias for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateAlias method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
AuthenticationFailedException An authentication error occurred.
DirectoryUnavailableException The specified directory is unavailable or could not be found.
EntityAlreadyExistsException The specified entity already exists.
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
UnsupportedOperationException The operation is not supported.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.CreateComputerInput{ ComputerName: aws.String("ComputerName"), // Required DirectoryId: aws.String("DirectoryId"), // Required Password: aws.String("ComputerPassword"), // Required ComputerAttributes: []*directoryservice.Attribute{ { // Required Name: aws.String("AttributeName"), Value: aws.String("AttributeValue"), }, // More values... }, OrganizationalUnitDistinguishedName: aws.String("OrganizationalUnitDN"), } resp, err := svc.CreateComputer(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See CreateComputer for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateComputer method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) CreateConditionalForwarder ¶ added in v1.1.19
func (c *DirectoryService) CreateConditionalForwarder(input *CreateConditionalForwarderInput) (*CreateConditionalForwarderOutput, error)
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:
EntityAlreadyExistsException The specified entity already exists.
EntityDoesNotExistException The specified entity could not be found.
DirectoryUnavailableException The specified directory is unavailable or could not be found.
InvalidParameterException One or more parameters are not valid.
UnsupportedOperationException The operation is not supported.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.CreateConditionalForwarderInput{ DirectoryId: aws.String("DirectoryId"), // Required DnsIpAddrs: []*string{ // Required aws.String("IpAddr"), // Required // More values... }, RemoteDomainName: aws.String("RemoteDomainName"), // Required } resp, err := svc.CreateConditionalForwarder(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) CreateConditionalForwarderRequest ¶ added in v1.1.19
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 can be used to capture response data after the request's "Send" method is called.
See CreateConditionalForwarder for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateConditionalForwarder method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) CreateDirectory ¶
func (c *DirectoryService) CreateDirectory(input *CreateDirectoryInput) (*CreateDirectoryOutput, error)
CreateDirectory API operation for AWS Directory Service.
Creates a 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 CreateDirectory for usage and error information.
Returned Error Codes:
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.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.CreateDirectoryInput{ Name: aws.String("DirectoryName"), // Required Password: aws.String("Password"), // Required Size: aws.String("DirectorySize"), // Required Description: aws.String("Description"), ShortName: aws.String("DirectoryShortName"), VpcSettings: &directoryservice.DirectoryVpcSettings{ SubnetIds: []*string{ // Required aws.String("SubnetId"), // Required // More values... }, VpcId: aws.String("VpcId"), // Required }, } resp, err := svc.CreateDirectory(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See CreateDirectory for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDirectory method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) CreateMicrosoftAD ¶ added in v1.0.5
func (c *DirectoryService) CreateMicrosoftAD(input *CreateMicrosoftADInput) (*CreateMicrosoftADOutput, error)
CreateMicrosoftAD API operation for AWS Directory Service.
Creates a Microsoft AD in the AWS cloud.
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:
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.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
UnsupportedOperationException The operation is not supported.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.CreateMicrosoftADInput{ Name: aws.String("DirectoryName"), // Required Password: aws.String("Password"), // Required VpcSettings: &directoryservice.DirectoryVpcSettings{ // Required SubnetIds: []*string{ // Required aws.String("SubnetId"), // Required // More values... }, VpcId: aws.String("VpcId"), // Required }, Description: aws.String("Description"), ShortName: aws.String("DirectoryShortName"), } resp, err := svc.CreateMicrosoftAD(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) CreateMicrosoftADRequest ¶ added in v1.0.5
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 can be used to capture response data after the request's "Send" method is called.
See CreateMicrosoftAD for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateMicrosoftAD method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
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.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.CreateSnapshotInput{ DirectoryId: aws.String("DirectoryId"), // Required Name: aws.String("SnapshotName"), } resp, err := svc.CreateSnapshot(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See CreateSnapshot for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateSnapshot method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) CreateTrust ¶ added in v1.0.5
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:
EntityAlreadyExistsException The specified entity already exists.
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
UnsupportedOperationException The operation is not supported.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.CreateTrustInput{ DirectoryId: aws.String("DirectoryId"), // Required RemoteDomainName: aws.String("RemoteDomainName"), // Required TrustDirection: aws.String("TrustDirection"), // Required TrustPassword: aws.String("TrustPassword"), // Required ConditionalForwarderIpAddrs: []*string{ aws.String("IpAddr"), // Required // More values... }, TrustType: aws.String("TrustType"), } resp, err := svc.CreateTrust(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) CreateTrustRequest ¶ added in v1.0.5
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 can be used to capture response data after the request's "Send" method is called.
See CreateTrust for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateTrust method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) DeleteConditionalForwarder ¶ added in v1.1.19
func (c *DirectoryService) DeleteConditionalForwarder(input *DeleteConditionalForwarderInput) (*DeleteConditionalForwarderOutput, error)
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:
EntityDoesNotExistException The specified entity could not be found.
DirectoryUnavailableException The specified directory is unavailable or could not be found.
InvalidParameterException One or more parameters are not valid.
UnsupportedOperationException The operation is not supported.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DeleteConditionalForwarderInput{ DirectoryId: aws.String("DirectoryId"), // Required RemoteDomainName: aws.String("RemoteDomainName"), // Required } resp, err := svc.DeleteConditionalForwarder(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DeleteConditionalForwarderRequest ¶ added in v1.1.19
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 can be used to capture response data after the request's "Send" method is called.
See DeleteConditionalForwarder for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteConditionalForwarder method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) DeleteDirectory ¶
func (c *DirectoryService) DeleteDirectory(input *DeleteDirectoryInput) (*DeleteDirectoryOutput, error)
DeleteDirectory API operation for AWS Directory Service.
Deletes an AWS Directory Service 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 DeleteDirectory for usage and error information.
Returned Error Codes:
EntityDoesNotExistException The specified entity could not be found.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DeleteDirectoryInput{ DirectoryId: aws.String("DirectoryId"), // Required } resp, err := svc.DeleteDirectory(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DeleteDirectory for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDirectory method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DeleteSnapshotInput{ SnapshotId: aws.String("SnapshotId"), // Required } resp, err := svc.DeleteSnapshot(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DeleteSnapshot for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteSnapshot method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) DeleteTrust ¶ added in v1.0.5
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
UnsupportedOperationException The operation is not supported.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DeleteTrustInput{ TrustId: aws.String("TrustId"), // Required DeleteAssociatedConditionalForwarder: aws.Bool(true), } resp, err := svc.DeleteTrust(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DeleteTrustRequest ¶ added in v1.0.5
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 can be used to capture response data after the request's "Send" method is called.
See DeleteTrust for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteTrust method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) DeregisterEventTopic ¶ added in v1.1.16
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DeregisterEventTopicInput{ DirectoryId: aws.String("DirectoryId"), // Required TopicName: aws.String("TopicName"), // Required } resp, err := svc.DeregisterEventTopic(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DeregisterEventTopicRequest ¶ added in v1.1.16
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 can be used to capture response data after the request's "Send" method is called.
See DeregisterEventTopic for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeregisterEventTopic method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) DescribeConditionalForwarders ¶ added in v1.1.19
func (c *DirectoryService) DescribeConditionalForwarders(input *DescribeConditionalForwardersInput) (*DescribeConditionalForwardersOutput, error)
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:
EntityDoesNotExistException The specified entity could not be found.
DirectoryUnavailableException The specified directory is unavailable or could not be found.
InvalidParameterException One or more parameters are not valid.
UnsupportedOperationException The operation is not supported.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DescribeConditionalForwardersInput{ DirectoryId: aws.String("DirectoryId"), // Required RemoteDomainNames: []*string{ aws.String("RemoteDomainName"), // Required // More values... }, } resp, err := svc.DescribeConditionalForwarders(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DescribeConditionalForwardersRequest ¶ added in v1.1.19
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 can be used to capture response data after the request's "Send" method is called.
See DescribeConditionalForwarders for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeConditionalForwarders method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
InvalidNextTokenException The NextToken value is not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DescribeDirectoriesInput{ DirectoryIds: []*string{ aws.String("DirectoryId"), // Required // More values... }, Limit: aws.Int64(1), NextToken: aws.String("NextToken"), } resp, err := svc.DescribeDirectories(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DescribeDirectories for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeDirectories method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) DescribeEventTopics ¶ added in v1.1.16
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DescribeEventTopicsInput{ DirectoryId: aws.String("DirectoryId"), TopicNames: []*string{ aws.String("TopicName"), // Required // More values... }, } resp, err := svc.DescribeEventTopics(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DescribeEventTopicsRequest ¶ added in v1.1.16
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 can be used to capture response data after the request's "Send" method is called.
See DescribeEventTopics for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeEventTopics method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
InvalidNextTokenException The NextToken value is not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DescribeSnapshotsInput{ DirectoryId: aws.String("DirectoryId"), Limit: aws.Int64(1), NextToken: aws.String("NextToken"), SnapshotIds: []*string{ aws.String("SnapshotId"), // Required // More values... }, } resp, err := svc.DescribeSnapshots(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DescribeSnapshots for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeSnapshots method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) DescribeTrusts ¶ added in v1.0.5
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidNextTokenException The NextToken value is not valid.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
UnsupportedOperationException The operation is not supported.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DescribeTrustsInput{ DirectoryId: aws.String("DirectoryId"), Limit: aws.Int64(1), NextToken: aws.String("NextToken"), TrustIds: []*string{ aws.String("TrustId"), // Required // More values... }, } resp, err := svc.DescribeTrusts(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DescribeTrustsRequest ¶ added in v1.0.5
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 can be used to capture response data after the request's "Send" method is called.
See DescribeTrusts for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeTrusts method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
EntityDoesNotExistException The specified entity could not be found.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DisableRadiusInput{ DirectoryId: aws.String("DirectoryId"), // Required } resp, err := svc.DisableRadius(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DisableRadius for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DisableRadius method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) DisableSso ¶ added in v0.9.9
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:
EntityDoesNotExistException The specified entity could not be found.
InsufficientPermissionsException The account does not have sufficient permission to perform the operation.
AuthenticationFailedException An authentication error occurred.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.DisableSsoInput{ DirectoryId: aws.String("DirectoryId"), // Required Password: aws.String("ConnectPassword"), UserName: aws.String("UserName"), } resp, err := svc.DisableSso(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) DisableSsoRequest ¶ added in v0.9.9
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 can be used to capture response data after the request's "Send" method is called.
See DisableSso for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DisableSso method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
InvalidParameterException One or more parameters are not valid.
EntityAlreadyExistsException The specified entity already exists.
EntityDoesNotExistException The specified entity could not be found.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.EnableRadiusInput{ DirectoryId: aws.String("DirectoryId"), // Required RadiusSettings: &directoryservice.RadiusSettings{ // Required AuthenticationProtocol: aws.String("RadiusAuthenticationProtocol"), DisplayLabel: aws.String("RadiusDisplayLabel"), RadiusPort: aws.Int64(1), RadiusRetries: aws.Int64(1), RadiusServers: []*string{ aws.String("Server"), // Required // More values... }, RadiusTimeout: aws.Int64(1), SharedSecret: aws.String("RadiusSharedSecret"), UseSameUsername: aws.Bool(true), }, } resp, err := svc.EnableRadius(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See EnableRadius for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the EnableRadius method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) EnableSso ¶ added in v0.9.9
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:
EntityDoesNotExistException The specified entity could not be found.
InsufficientPermissionsException The account does not have sufficient permission to perform the operation.
AuthenticationFailedException An authentication error occurred.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.EnableSsoInput{ DirectoryId: aws.String("DirectoryId"), // Required Password: aws.String("ConnectPassword"), UserName: aws.String("UserName"), } resp, err := svc.EnableSso(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) EnableSsoRequest ¶ added in v0.9.9
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 can be used to capture response data after the request's "Send" method is called.
See EnableSso for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the EnableSso method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
EntityDoesNotExistException The specified entity could not be found.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) var params *directoryservice.GetDirectoryLimitsInput resp, err := svc.GetDirectoryLimits(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See GetDirectoryLimits for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDirectoryLimits method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
EntityDoesNotExistException The specified entity could not be found.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.GetSnapshotLimitsInput{ DirectoryId: aws.String("DirectoryId"), // Required } resp, err := svc.GetSnapshotLimits(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See GetSnapshotLimits for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSnapshotLimits method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) ListIpRoutes ¶ added in v1.3.0
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidNextTokenException The NextToken value is not valid.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.ListIpRoutesInput{ DirectoryId: aws.String("DirectoryId"), // Required Limit: aws.Int64(1), NextToken: aws.String("NextToken"), } resp, err := svc.ListIpRoutes(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) ListIpRoutesRequest ¶ added in v1.3.0
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 can be used to capture response data after the request's "Send" method is called.
See ListIpRoutes for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListIpRoutes method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) ListTagsForResource ¶ added in v1.2.6
func (c *DirectoryService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for AWS Directory Service.
Lists all tags on an Amazon Directory Services 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:
EntityDoesNotExistException The specified entity could not be found.
InvalidNextTokenException The NextToken value is not valid.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.ListTagsForResourceInput{ ResourceId: aws.String("ResourceId"), // Required Limit: aws.Int64(1), NextToken: aws.String("NextToken"), } resp, err := svc.ListTagsForResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) ListTagsForResourceRequest ¶ added in v1.2.6
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 can be used to capture response data after the request's "Send" method is called.
See ListTagsForResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListTagsForResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) RegisterEventTopic ¶ added in v1.1.16
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.RegisterEventTopicInput{ DirectoryId: aws.String("DirectoryId"), // Required TopicName: aws.String("TopicName"), // Required } resp, err := svc.RegisterEventTopic(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) RegisterEventTopicRequest ¶ added in v1.1.16
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 can be used to capture response data after the request's "Send" method is called.
See RegisterEventTopic for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RegisterEventTopic method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) RemoveIpRoutes ¶ added in v1.3.0
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
DirectoryUnavailableException The specified directory is unavailable or could not be found.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.RemoveIpRoutesInput{ CidrIps: []*string{ // Required aws.String("CidrIp"), // Required // More values... }, DirectoryId: aws.String("DirectoryId"), // Required } resp, err := svc.RemoveIpRoutes(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) RemoveIpRoutesRequest ¶ added in v1.3.0
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 can be used to capture response data after the request's "Send" method is called.
See RemoveIpRoutes for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemoveIpRoutes method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) RemoveTagsFromResource ¶ added in v1.2.6
func (c *DirectoryService) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)
RemoveTagsFromResource API operation for AWS Directory Service.
Removes tags from an Amazon Directory Services 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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.RemoveTagsFromResourceInput{ ResourceId: aws.String("ResourceId"), // Required TagKeys: []*string{ // Required aws.String("TagKey"), // Required // More values... }, } resp, err := svc.RemoveTagsFromResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) RemoveTagsFromResourceRequest ¶ added in v1.2.6
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 can be used to capture response data after the request's "Send" method is called.
See RemoveTagsFromResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemoveTagsFromResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.RestoreFromSnapshotInput{ SnapshotId: aws.String("SnapshotId"), // Required } resp, err := svc.RestoreFromSnapshot(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See RestoreFromSnapshot for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RestoreFromSnapshot method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) UpdateConditionalForwarder ¶ added in v1.1.19
func (c *DirectoryService) UpdateConditionalForwarder(input *UpdateConditionalForwarderInput) (*UpdateConditionalForwarderOutput, error)
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:
EntityDoesNotExistException The specified entity could not be found.
DirectoryUnavailableException The specified directory is unavailable or could not be found.
InvalidParameterException One or more parameters are not valid.
UnsupportedOperationException The operation is not supported.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.UpdateConditionalForwarderInput{ DirectoryId: aws.String("DirectoryId"), // Required DnsIpAddrs: []*string{ // Required aws.String("IpAddr"), // Required // More values... }, RemoteDomainName: aws.String("RemoteDomainName"), // Required } resp, err := svc.UpdateConditionalForwarder(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) UpdateConditionalForwarderRequest ¶ added in v1.1.19
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 can be used to capture response data after the request's "Send" method is called.
See UpdateConditionalForwarder for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateConditionalForwarder method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
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:
InvalidParameterException One or more parameters are not valid.
EntityDoesNotExistException The specified entity could not be found.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.UpdateRadiusInput{ DirectoryId: aws.String("DirectoryId"), // Required RadiusSettings: &directoryservice.RadiusSettings{ // Required AuthenticationProtocol: aws.String("RadiusAuthenticationProtocol"), DisplayLabel: aws.String("RadiusDisplayLabel"), RadiusPort: aws.Int64(1), RadiusRetries: aws.Int64(1), RadiusServers: []*string{ aws.String("Server"), // Required // More values... }, RadiusTimeout: aws.Int64(1), SharedSecret: aws.String("RadiusSharedSecret"), UseSameUsername: aws.Bool(true), }, } resp, err := svc.UpdateRadius(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See UpdateRadius for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateRadius method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*DirectoryService) VerifyTrust ¶ added in v1.0.5
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:
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ClientException A client exception has occurred.
ServiceException An exception has occurred in AWS Directory Service.
UnsupportedOperationException The operation is not supported.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/directoryservice" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := directoryservice.New(sess) params := &directoryservice.VerifyTrustInput{ TrustId: aws.String("TrustId"), // Required } resp, err := svc.VerifyTrust(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*DirectoryService) VerifyTrustRequest ¶ added in v1.0.5
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 can be used to capture response data after the request's "Send" method is called.
See VerifyTrust for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the VerifyTrust method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
type DirectoryVpcSettings ¶ added in v0.9.9
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.9
func (s DirectoryVpcSettings) GoString() string
GoString returns the string representation
func (DirectoryVpcSettings) String ¶ added in v0.9.9
func (s DirectoryVpcSettings) String() string
String returns the string representation
func (*DirectoryVpcSettings) Validate ¶ added in v1.1.24
func (s *DirectoryVpcSettings) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DirectoryVpcSettingsDescription ¶ added in v0.9.9
type DirectoryVpcSettingsDescription struct { // The list of Availability Zones that the directory is in. AvailabilityZones []*string `type:"list"` // The security group identifier for the directory. If the directory was created // before 8/1/2014, this is the identifier of the directory members security // group that was created when the directory was created. If the directory was // created after this date, this value is null. 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.9
func (s DirectoryVpcSettingsDescription) GoString() string
GoString returns the string representation
func (DirectoryVpcSettingsDescription) String ¶ added in v0.9.9
func (s DirectoryVpcSettingsDescription) String() string
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.6
func (s DisableRadiusInput) GoString() string
GoString returns the string representation
func (DisableRadiusInput) String ¶ added in v0.6.6
func (s DisableRadiusInput) String() string
String returns the string representation
func (*DisableRadiusInput) Validate ¶ added in v1.1.24
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.6
func (s DisableRadiusOutput) GoString() string
GoString returns the string representation
func (DisableRadiusOutput) String ¶ added in v0.6.6
func (s DisableRadiusOutput) String() string
String returns the string representation
type DisableSsoInput ¶ added in v0.9.9
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.9
func (s DisableSsoInput) GoString() string
GoString returns the string representation
func (DisableSsoInput) String ¶ added in v0.9.9
func (s DisableSsoInput) String() string
String returns the string representation
func (*DisableSsoInput) Validate ¶ added in v1.1.24
func (s *DisableSsoInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisableSsoOutput ¶ added in v0.9.9
type DisableSsoOutput struct {
// contains filtered or unexported fields
}
Contains the results of the DisableSso operation.
func (DisableSsoOutput) GoString ¶ added in v0.9.9
func (s DisableSsoOutput) GoString() string
GoString returns the string representation
func (DisableSsoOutput) String ¶ added in v0.9.9
func (s DisableSsoOutput) 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.6
func (s EnableRadiusInput) GoString() string
GoString returns the string representation
func (EnableRadiusInput) String ¶ added in v0.6.6
func (s EnableRadiusInput) String() string
String returns the string representation
func (*EnableRadiusInput) Validate ¶ added in v1.1.24
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.6
func (s EnableRadiusOutput) GoString() string
GoString returns the string representation
func (EnableRadiusOutput) String ¶ added in v0.6.6
func (s EnableRadiusOutput) String() string
String returns the string representation
type EnableSsoInput ¶ added in v0.9.9
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.9
func (s EnableSsoInput) GoString() string
GoString returns the string representation
func (EnableSsoInput) String ¶ added in v0.9.9
func (s EnableSsoInput) String() string
String returns the string representation
func (*EnableSsoInput) Validate ¶ added in v1.1.24
func (s *EnableSsoInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EnableSsoOutput ¶ added in v0.9.9
type EnableSsoOutput struct {
// contains filtered or unexported fields
}
Contains the results of the EnableSso operation.
func (EnableSsoOutput) GoString ¶ added in v0.9.9
func (s EnableSsoOutput) GoString() string
GoString returns the string representation
func (EnableSsoOutput) String ¶ added in v0.9.9
func (s EnableSsoOutput) String() string
String returns the string representation
type EventTopic ¶ added in v1.1.16
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.16
func (s EventTopic) GoString() string
GoString returns the string representation
func (EventTopic) String ¶ added in v1.1.16
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.6
func (s GetDirectoryLimitsInput) GoString() string
GoString returns the string representation
func (GetDirectoryLimitsInput) String ¶ added in v0.6.6
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.6
func (s GetDirectoryLimitsOutput) GoString() string
GoString returns the string representation
func (GetDirectoryLimitsOutput) String ¶ added in v0.6.6
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.6
func (s GetSnapshotLimitsInput) GoString() string
GoString returns the string representation
func (GetSnapshotLimitsInput) String ¶ added in v0.6.6
func (s GetSnapshotLimitsInput) String() string
String returns the string representation
func (*GetSnapshotLimitsInput) Validate ¶ added in v1.1.24
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.6
func (s GetSnapshotLimitsOutput) GoString() string
GoString returns the string representation
func (GetSnapshotLimitsOutput) String ¶ added in v0.6.6
func (s GetSnapshotLimitsOutput) String() string
String returns the string representation
type IpRoute ¶ added in v1.3.0
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.
type IpRouteInfo ¶ added in v1.3.0
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.3.0
func (s IpRouteInfo) GoString() string
GoString returns the string representation
func (IpRouteInfo) String ¶ added in v1.3.0
func (s IpRouteInfo) String() string
String returns the string representation
type ListIpRoutesInput ¶ added in v1.3.0
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.3.0
func (s ListIpRoutesInput) GoString() string
GoString returns the string representation
func (ListIpRoutesInput) String ¶ added in v1.3.0
func (s ListIpRoutesInput) String() string
String returns the string representation
func (*ListIpRoutesInput) Validate ¶ added in v1.3.0
func (s *ListIpRoutesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListIpRoutesOutput ¶ added in v1.3.0
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.3.0
func (s ListIpRoutesOutput) GoString() string
GoString returns the string representation
func (ListIpRoutesOutput) String ¶ added in v1.3.0
func (s ListIpRoutesOutput) String() string
String returns the string representation
type ListTagsForResourceInput ¶ added in v1.2.6
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.6
func (s ListTagsForResourceInput) GoString() string
GoString returns the string representation
func (ListTagsForResourceInput) String ¶ added in v1.2.6
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶ added in v1.2.6
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v1.2.6
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.6
func (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation
func (ListTagsForResourceOutput) String ¶ added in v1.2.6
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"` 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.6
func (s RadiusSettings) GoString() string
GoString returns the string representation
func (RadiusSettings) String ¶ added in v0.6.6
func (s RadiusSettings) String() string
String returns the string representation
func (*RadiusSettings) Validate ¶ added in v1.1.24
func (s *RadiusSettings) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterEventTopicInput ¶ added in v1.1.16
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.16
func (s RegisterEventTopicInput) GoString() string
GoString returns the string representation
func (RegisterEventTopicInput) String ¶ added in v1.1.16
func (s RegisterEventTopicInput) String() string
String returns the string representation
func (*RegisterEventTopicInput) Validate ¶ added in v1.1.24
func (s *RegisterEventTopicInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterEventTopicOutput ¶ added in v1.1.16
type RegisterEventTopicOutput struct {
// contains filtered or unexported fields
}
The result of a RegisterEventTopic request.
func (RegisterEventTopicOutput) GoString ¶ added in v1.1.16
func (s RegisterEventTopicOutput) GoString() string
GoString returns the string representation
func (RegisterEventTopicOutput) String ¶ added in v1.1.16
func (s RegisterEventTopicOutput) String() string
String returns the string representation
type RemoveIpRoutesInput ¶ added in v1.3.0
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.3.0
func (s RemoveIpRoutesInput) GoString() string
GoString returns the string representation
func (RemoveIpRoutesInput) String ¶ added in v1.3.0
func (s RemoveIpRoutesInput) String() string
String returns the string representation
func (*RemoveIpRoutesInput) Validate ¶ added in v1.3.0
func (s *RemoveIpRoutesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemoveIpRoutesOutput ¶ added in v1.3.0
type RemoveIpRoutesOutput struct {
// contains filtered or unexported fields
}
func (RemoveIpRoutesOutput) GoString ¶ added in v1.3.0
func (s RemoveIpRoutesOutput) GoString() string
GoString returns the string representation
func (RemoveIpRoutesOutput) String ¶ added in v1.3.0
func (s RemoveIpRoutesOutput) String() string
String returns the string representation
type RemoveTagsFromResourceInput ¶ added in v1.2.6
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.6
func (s RemoveTagsFromResourceInput) GoString() string
GoString returns the string representation
func (RemoveTagsFromResourceInput) String ¶ added in v1.2.6
func (s RemoveTagsFromResourceInput) String() string
String returns the string representation
func (*RemoveTagsFromResourceInput) Validate ¶ added in v1.2.6
func (s *RemoveTagsFromResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemoveTagsFromResourceOutput ¶ added in v1.2.6
type RemoveTagsFromResourceOutput struct {
// contains filtered or unexported fields
}
func (RemoveTagsFromResourceOutput) GoString ¶ added in v1.2.6
func (s RemoveTagsFromResourceOutput) GoString() string
GoString returns the string representation
func (RemoveTagsFromResourceOutput) String ¶ added in v1.2.6
func (s RemoveTagsFromResourceOutput) 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.6
func (s RestoreFromSnapshotInput) GoString() string
GoString returns the string representation
func (RestoreFromSnapshotInput) String ¶ added in v0.6.6
func (s RestoreFromSnapshotInput) String() string
String returns the string representation
func (*RestoreFromSnapshotInput) Validate ¶ added in v1.1.24
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.6
func (s RestoreFromSnapshotOutput) GoString() string
GoString returns the string representation
func (RestoreFromSnapshotOutput) String ¶ added in v0.6.6
func (s RestoreFromSnapshotOutput) 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.
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.6
func (s SnapshotLimits) GoString() string
GoString returns the string representation
func (SnapshotLimits) String ¶ added in v0.6.6
func (s SnapshotLimits) String() string
String returns the string representation
type Tag ¶ added in v1.2.6
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 an Amazon Directory Services directory consisting of a key-value pair.
type Trust ¶ added in v1.0.5
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.
type UpdateConditionalForwarderInput ¶ added in v1.1.19
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.19
func (s UpdateConditionalForwarderInput) GoString() string
GoString returns the string representation
func (UpdateConditionalForwarderInput) String ¶ added in v1.1.19
func (s UpdateConditionalForwarderInput) String() string
String returns the string representation
func (*UpdateConditionalForwarderInput) Validate ¶ added in v1.1.24
func (s *UpdateConditionalForwarderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateConditionalForwarderOutput ¶ added in v1.1.19
type UpdateConditionalForwarderOutput struct {
// contains filtered or unexported fields
}
The result of an UpdateConditionalForwarder request.
func (UpdateConditionalForwarderOutput) GoString ¶ added in v1.1.19
func (s UpdateConditionalForwarderOutput) GoString() string
GoString returns the string representation
func (UpdateConditionalForwarderOutput) String ¶ added in v1.1.19
func (s UpdateConditionalForwarderOutput) String() string
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.6
func (s UpdateRadiusInput) GoString() string
GoString returns the string representation
func (UpdateRadiusInput) String ¶ added in v0.6.6
func (s UpdateRadiusInput) String() string
String returns the string representation
func (*UpdateRadiusInput) Validate ¶ added in v1.1.24
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.6
func (s UpdateRadiusOutput) GoString() string
GoString returns the string representation
func (UpdateRadiusOutput) String ¶ added in v0.6.6
func (s UpdateRadiusOutput) String() string
String returns the string representation
type VerifyTrustInput ¶ added in v1.0.5
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.5
func (s VerifyTrustInput) GoString() string
GoString returns the string representation
func (VerifyTrustInput) String ¶ added in v1.0.5
func (s VerifyTrustInput) String() string
String returns the string representation
func (*VerifyTrustInput) Validate ¶ added in v1.1.24
func (s *VerifyTrustInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type VerifyTrustOutput ¶ added in v1.0.5
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.5
func (s VerifyTrustOutput) GoString() string
GoString returns the string representation
func (VerifyTrustOutput) String ¶ added in v1.0.5
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. |