Documentation ¶
Overview ¶
Package applicationdiscoveryservice provides a client for AWS Application Discovery Service.
Index ¶
- Constants
- type AgentConfigStatus
- type AgentInfo
- type AgentNetworkInfo
- type ApplicationDiscoveryService
- func (c *ApplicationDiscoveryService) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)
- func (c *ApplicationDiscoveryService) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput)
- func (c *ApplicationDiscoveryService) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)
- func (c *ApplicationDiscoveryService) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)
- func (c *ApplicationDiscoveryService) DescribeAgents(input *DescribeAgentsInput) (*DescribeAgentsOutput, error)
- func (c *ApplicationDiscoveryService) DescribeAgentsRequest(input *DescribeAgentsInput) (req *request.Request, output *DescribeAgentsOutput)
- func (c *ApplicationDiscoveryService) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)
- func (c *ApplicationDiscoveryService) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)
- func (c *ApplicationDiscoveryService) ExportConfigurations(input *ExportConfigurationsInput) (*ExportConfigurationsOutput, error)
- func (c *ApplicationDiscoveryService) ExportConfigurationsRequest(input *ExportConfigurationsInput) (req *request.Request, output *ExportConfigurationsOutput)
- func (c *ApplicationDiscoveryService) GetConfigurationAttributes(input *GetConfigurationAttributesInput) (*GetConfigurationAttributesOutput, error)
- func (c *ApplicationDiscoveryService) GetConfigurationAttributesRequest(input *GetConfigurationAttributesInput) (req *request.Request, output *GetConfigurationAttributesOutput)
- func (c *ApplicationDiscoveryService) GetExportStatus(input *GetExportStatusInput) (*GetExportStatusOutput, error)
- func (c *ApplicationDiscoveryService) GetExportStatusRequest(input *GetExportStatusInput) (req *request.Request, output *GetExportStatusOutput)
- func (c *ApplicationDiscoveryService) ListConfigurations(input *ListConfigurationsInput) (*ListConfigurationsOutput, error)
- func (c *ApplicationDiscoveryService) ListConfigurationsRequest(input *ListConfigurationsInput) (req *request.Request, output *ListConfigurationsOutput)
- func (c *ApplicationDiscoveryService) RemoveConfiguration(input *RemoveConfigurationInput) (*RemoveConfigurationOutput, error)
- func (c *ApplicationDiscoveryService) RemoveConfigurationRequest(input *RemoveConfigurationInput) (req *request.Request, output *RemoveConfigurationOutput)
- func (c *ApplicationDiscoveryService) StartDataCollectionByAgentIds(input *StartDataCollectionByAgentIdsInput) (*StartDataCollectionByAgentIdsOutput, error)
- func (c *ApplicationDiscoveryService) StartDataCollectionByAgentIdsRequest(input *StartDataCollectionByAgentIdsInput) (req *request.Request, output *StartDataCollectionByAgentIdsOutput)
- func (c *ApplicationDiscoveryService) StopDataCollectionByAgentIds(input *StopDataCollectionByAgentIdsInput) (*StopDataCollectionByAgentIdsOutput, error)
- func (c *ApplicationDiscoveryService) StopDataCollectionByAgentIdsRequest(input *StopDataCollectionByAgentIdsInput) (req *request.Request, output *StopDataCollectionByAgentIdsOutput)
- type Attribute
- type ConfigurationTag
- type CreateTagsInput
- type CreateTagsOutput
- type DeleteTagsInput
- type DeleteTagsOutput
- type DescribeAgentsInput
- type DescribeAgentsOutput
- type DescribeTagsInput
- type DescribeTagsOutput
- type ExportConfigurationsInput
- type ExportConfigurationsOutput
- type Filter
- type GetConfigurationAttributesInput
- type GetConfigurationAttributesOutput
- type GetExportStatusInput
- type GetExportStatusOutput
- type ListConfigurationsInput
- type ListConfigurationsOutput
- type RemoveConfigurationInput
- type RemoveConfigurationOutput
- type StartDataCollectionByAgentIdsInput
- type StartDataCollectionByAgentIdsOutput
- type StopDataCollectionByAgentIdsInput
- type StopDataCollectionByAgentIdsOutput
- type Tag
- type TagFilter
Examples ¶
- ApplicationDiscoveryService.CreateTags
- ApplicationDiscoveryService.DeleteTags
- ApplicationDiscoveryService.DescribeAgents
- ApplicationDiscoveryService.DescribeTags
- ApplicationDiscoveryService.ExportConfigurations
- ApplicationDiscoveryService.GetConfigurationAttributes
- ApplicationDiscoveryService.GetExportStatus
- ApplicationDiscoveryService.ListConfigurations
- ApplicationDiscoveryService.RemoveConfiguration
- ApplicationDiscoveryService.StartDataCollectionByAgentIds
- ApplicationDiscoveryService.StopDataCollectionByAgentIds
Constants ¶
const ( // @enum AgentStatus AgentStatusHealthy = "HEALTHY" // @enum AgentStatus AgentStatusUnhealthy = "UNHEALTHY" // @enum AgentStatus AgentStatusRunning = "RUNNING" // @enum AgentStatus AgentStatusUnknown = "UNKNOWN" // @enum AgentStatus AgentStatusBlacklisted = "BLACKLISTED" // @enum AgentStatus AgentStatusShutdown = "SHUTDOWN" )
const ( // @enum ConfigurationItemType ConfigurationItemTypeServer = "SERVER" // @enum ConfigurationItemType ConfigurationItemTypeProcess = "PROCESS" // @enum ConfigurationItemType ConfigurationItemTypeConnection = "CONNECTION" )
const ServiceName = "discovery"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentConfigStatus ¶
type AgentConfigStatus struct { // The agent ID. AgentId *string `locationName:"agentId" type:"string"` // Information about whether or not the agent configuration was updated. ConfigUpdated *bool `locationName:"configUpdated" type:"boolean"` // A description of the operation performed. Description *string `locationName:"description" type:"string"` // contains filtered or unexported fields }
Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation, and whether or not the agent configuration was updated.
func (AgentConfigStatus) GoString ¶
func (s AgentConfigStatus) GoString() string
GoString returns the string representation
func (AgentConfigStatus) String ¶
func (s AgentConfigStatus) String() string
String returns the string representation
type AgentInfo ¶
type AgentInfo struct { // The agent ID. AgentId *string `locationName:"agentId" type:"string"` // Network details about the host where the agent resides. AgentNetworkInfoList []*AgentNetworkInfo `locationName:"agentNetworkInfoList" type:"list"` ConnectorId *string `locationName:"connectorId" type:"string"` // The health of the agent. Health *string `locationName:"health" type:"string" enum:"AgentStatus"` // The name of the host where the agent resides. The host can be a server, virtual // machine, or an AWS EC2 instance. HostName *string `locationName:"hostName" type:"string"` // The agent version Version *string `locationName:"version" type:"string"` // contains filtered or unexported fields }
Information about agents associated with the user’s AWS account. Information includes agent IDs, IP addresses, MAC addresses, agent health, hostname where the agent resides, and agent version for each agent.
type AgentNetworkInfo ¶
type AgentNetworkInfo struct { // The IP address for the host where the agent resides. IpAddress *string `locationName:"ipAddress" type:"string"` // The MAC address for the host where the agent resides. MacAddress *string `locationName:"macAddress" type:"string"` // contains filtered or unexported fields }
Network details about the host where the agent resides.
func (AgentNetworkInfo) GoString ¶
func (s AgentNetworkInfo) GoString() string
GoString returns the string representation
func (AgentNetworkInfo) String ¶
func (s AgentNetworkInfo) String() string
String returns the string representation
type ApplicationDiscoveryService ¶
This is the AWS Discovery Service API Reference. The AWS Discovery Service streamlines the process of migrating to Amazon Web Services by helping you identify assets in your data center, including servers, virtual machines, applications, application dependencies, and network infrastructure. You can use this information to find the workloads that make up an application, analyze dependencies, and build migration strategies. The service also collects performance data about your workloads which you can use to assess migration outcomes.
This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs (http://aws.amazon.com/tools/#SDKs).
This guide is intended for use with the AWS Discovery Service user guide (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/remote-commands-prereq.html).
The following are short descriptions of each API action, organized by function.
Managing AWS Agents
The AWS agent is an Amazon application that you install on servers and virtual machines in your data center or on Amazon EC2 instances. The agent captures server configuration and activity information (including hardware profile, network, file system, and process activity) and sends this data to the AWS Application Discovery Service. The Discovery Service processes this data and maps the application dependencies for your workloads.
StartDataCollectionByAgentIds: Instructs the specified agents to start
collecting data. Agents can reside on host servers or virtual machines in your data center or on AWS EC2 instances.
StopDataCollectionByAgentIds: Instructs the specified agents to stop
collecting data.
DescribeAgents: Lists AWS agents by ID or lists all agents associated
with your user account if you did not specify an agent ID. The output includes agent IDs, IP addresses, MAC addresses, agent health, host name where the agent resides, and the version number of each agent.
Querying Configuration Items
A configuration item is an IT asset that was discovered in your data center by an AWS agent. With the Discovery Service, you can specify filters and query specific configuration items. For example, using this API, you could create a filter to query for a process configuration item named apache and an operating system configuration item named Ubuntu.
GetConfigurationAttributes: Retrieves a list of attributes for a specific
configuration ID. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
ListConfigurations: Retrieves a list of configurations items according
to the criteria you specify in a filter. The filter criteria identify relationship requirements. For example, the following filter specifies criteria of process.name and values of nginx and apache.
ConfigurationType = Process Filters = [WebServerCriteria] WebServerCriteria
= { ‘key’ : process.name, ‘values’ : [ ‘nginx’, ‘apache’ ], ‘condition’ : ‘contains’ }
Tagging Discovered Configuration Items
You can tag discovered configuration items. Tags are metadata that help you categorize IT assets in your data center. Tags use a key,value format. For example, {"key": "serverType", "value": "webServer"}.
CreateTags: Creates one or more tags for a configuration item. Tags are
metadata that help you categorize IT assets.
DescribeTags: Retrieve a list of configuration items that are tagged
with a specific tag. Or retrieve a list all tags assigned to a specific configuration item.
DeleteTags: Deletes one or more tags associated with a configuration
item.
Exporting Data
You can export discovered data to an Amazon S3 bucket in the form of CSV files.
ExportConfigurations: Exports all discovered configuration data to an
Amazon S3 bucket. Data includes processes, connections, servers, and system performance.
GetExportStatus: Gets the status of the data export. When the export
is complete, the service returns an Amazon S3 URL where you can download CSV files that include the data. 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) *ApplicationDiscoveryService
New creates a new instance of the ApplicationDiscoveryService 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 ApplicationDiscoveryService client from just a session. svc := applicationdiscoveryservice.New(mySession) // Create a ApplicationDiscoveryService client with additional configuration svc := applicationdiscoveryservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*ApplicationDiscoveryService) CreateTags ¶
func (c *ApplicationDiscoveryService) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)
Creates one or more tags for a configuration item. Tags are metadata that help you categorize IT assets.
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.CreateTagsInput{ ConfigurationIds: []*string{ // Required aws.String("ConfigurationId"), // Required // More values... }, Tags: []*applicationdiscoveryservice.Tag{ // Required { // Required Key: aws.String("TagKey"), // Required Value: aws.String("TagValue"), // Required }, // More values... }, } resp, err := svc.CreateTags(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 (*ApplicationDiscoveryService) CreateTagsRequest ¶
func (c *ApplicationDiscoveryService) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput)
CreateTagsRequest generates a request for the CreateTags operation.
func (*ApplicationDiscoveryService) DeleteTags ¶
func (c *ApplicationDiscoveryService) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)
Deletes one or more tags associated with a configuration item.
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.DeleteTagsInput{ ConfigurationIds: []*string{ // Required aws.String("ConfigurationId"), // Required // More values... }, Tags: []*applicationdiscoveryservice.Tag{ { // Required Key: aws.String("TagKey"), // Required Value: aws.String("TagValue"), // Required }, // More values... }, } resp, err := svc.DeleteTags(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 (*ApplicationDiscoveryService) DeleteTagsRequest ¶
func (c *ApplicationDiscoveryService) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)
DeleteTagsRequest generates a request for the DeleteTags operation.
func (*ApplicationDiscoveryService) DescribeAgents ¶
func (c *ApplicationDiscoveryService) DescribeAgents(input *DescribeAgentsInput) (*DescribeAgentsOutput, error)
Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID.
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.DescribeAgentsInput{ AgentIds: []*string{ aws.String("AgentId"), // Required // More values... }, MaxResults: aws.Int64(1), NextToken: aws.String("NextToken"), } resp, err := svc.DescribeAgents(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 (*ApplicationDiscoveryService) DescribeAgentsRequest ¶
func (c *ApplicationDiscoveryService) DescribeAgentsRequest(input *DescribeAgentsInput) (req *request.Request, output *DescribeAgentsOutput)
DescribeAgentsRequest generates a request for the DescribeAgents operation.
func (*ApplicationDiscoveryService) DescribeTags ¶
func (c *ApplicationDiscoveryService) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)
Retrieve a list of configuration items that are tagged with a specific tag. Or retrieve a list all tags assigned to a specific configuration item.
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.DescribeTagsInput{ Filter: []*applicationdiscoveryservice.TagFilter{ { // Required Name: aws.String("FilterName"), // Required Values: []*string{ // Required aws.String("FilterValue"), // Required // More values... }, }, // More values... }, MaxResults: aws.Int64(1), NextToken: aws.String("NextToken"), } resp, err := svc.DescribeTags(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 (*ApplicationDiscoveryService) DescribeTagsRequest ¶
func (c *ApplicationDiscoveryService) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)
DescribeTagsRequest generates a request for the DescribeTags operation.
func (*ApplicationDiscoveryService) ExportConfigurations ¶
func (c *ApplicationDiscoveryService) ExportConfigurations(input *ExportConfigurationsInput) (*ExportConfigurationsOutput, error)
Exports the selected configurations to an Amazon S3 bucket.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) var params *applicationdiscoveryservice.ExportConfigurationsInput resp, err := svc.ExportConfigurations(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 (*ApplicationDiscoveryService) ExportConfigurationsRequest ¶
func (c *ApplicationDiscoveryService) ExportConfigurationsRequest(input *ExportConfigurationsInput) (req *request.Request, output *ExportConfigurationsOutput)
ExportConfigurationsRequest generates a request for the ExportConfigurations operation.
func (*ApplicationDiscoveryService) GetConfigurationAttributes ¶
func (c *ApplicationDiscoveryService) GetConfigurationAttributes(input *GetConfigurationAttributesInput) (*GetConfigurationAttributesOutput, error)
Retrieve a list of attributes for a specific configuration ID. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.GetConfigurationAttributesInput{ ConfigurationIds: []*string{ // Required aws.String("ConfigurationId"), // Required // More values... }, } resp, err := svc.GetConfigurationAttributes(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 (*ApplicationDiscoveryService) GetConfigurationAttributesRequest ¶
func (c *ApplicationDiscoveryService) GetConfigurationAttributesRequest(input *GetConfigurationAttributesInput) (req *request.Request, output *GetConfigurationAttributesOutput)
GetConfigurationAttributesRequest generates a request for the GetConfigurationAttributes operation.
func (*ApplicationDiscoveryService) GetExportStatus ¶
func (c *ApplicationDiscoveryService) GetExportStatus(input *GetExportStatusInput) (*GetExportStatusOutput, error)
Retrieves the status of a given export process.
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.GetExportStatusInput{ ExportId: aws.String("ConfigurationExportId"), // Required } resp, err := svc.GetExportStatus(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 (*ApplicationDiscoveryService) GetExportStatusRequest ¶
func (c *ApplicationDiscoveryService) GetExportStatusRequest(input *GetExportStatusInput) (req *request.Request, output *GetExportStatusOutput)
GetExportStatusRequest generates a request for the GetExportStatus operation.
func (*ApplicationDiscoveryService) ListConfigurations ¶
func (c *ApplicationDiscoveryService) ListConfigurations(input *ListConfigurationsInput) (*ListConfigurationsOutput, error)
Retrieve a list of configurations items according to the criteria you specify in a filter. The filter criteria identify relationship requirements.
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.ListConfigurationsInput{ ConfigurationType: aws.String("ConfigurationItemType"), // Required Filters: []*applicationdiscoveryservice.Filter{ { // Required Condition: aws.String("Condition"), // Required Name: aws.String("String"), // Required Values: []*string{ // Required aws.String("FilterValue"), // Required // More values... }, }, // More values... }, MaxResults: aws.Int64(1), NextToken: aws.String("NextToken"), } resp, err := svc.ListConfigurations(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 (*ApplicationDiscoveryService) ListConfigurationsRequest ¶
func (c *ApplicationDiscoveryService) ListConfigurationsRequest(input *ListConfigurationsInput) (req *request.Request, output *ListConfigurationsOutput)
ListConfigurationsRequest generates a request for the ListConfigurations operation.
func (*ApplicationDiscoveryService) RemoveConfiguration ¶
func (c *ApplicationDiscoveryService) RemoveConfiguration(input *RemoveConfigurationInput) (*RemoveConfigurationOutput, error)
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.RemoveConfigurationInput{ ConfigurationId: aws.String("ConfigurationId"), // Required } resp, err := svc.RemoveConfiguration(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 (*ApplicationDiscoveryService) RemoveConfigurationRequest ¶
func (c *ApplicationDiscoveryService) RemoveConfigurationRequest(input *RemoveConfigurationInput) (req *request.Request, output *RemoveConfigurationOutput)
RemoveConfigurationRequest generates a request for the RemoveConfiguration operation.
func (*ApplicationDiscoveryService) StartDataCollectionByAgentIds ¶
func (c *ApplicationDiscoveryService) StartDataCollectionByAgentIds(input *StartDataCollectionByAgentIdsInput) (*StartDataCollectionByAgentIdsOutput, error)
Instructs the specified agents to start collecting data. Agents can reside on host servers or virtual machines in your data center or on AWS EC2 instances.
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.StartDataCollectionByAgentIdsInput{ AgentIds: []*string{ // Required aws.String("AgentId"), // Required // More values... }, } resp, err := svc.StartDataCollectionByAgentIds(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 (*ApplicationDiscoveryService) StartDataCollectionByAgentIdsRequest ¶
func (c *ApplicationDiscoveryService) StartDataCollectionByAgentIdsRequest(input *StartDataCollectionByAgentIdsInput) (req *request.Request, output *StartDataCollectionByAgentIdsOutput)
StartDataCollectionByAgentIdsRequest generates a request for the StartDataCollectionByAgentIds operation.
func (*ApplicationDiscoveryService) StopDataCollectionByAgentIds ¶
func (c *ApplicationDiscoveryService) StopDataCollectionByAgentIds(input *StopDataCollectionByAgentIdsInput) (*StopDataCollectionByAgentIdsOutput, error)
Instructs the specified agents to stop collecting data.
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/applicationdiscoveryservice" ) func main() { svc := applicationdiscoveryservice.New(session.New()) params := &applicationdiscoveryservice.StopDataCollectionByAgentIdsInput{ AgentIds: []*string{ // Required aws.String("AgentId"), // Required // More values... }, } resp, err := svc.StopDataCollectionByAgentIds(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 (*ApplicationDiscoveryService) StopDataCollectionByAgentIdsRequest ¶
func (c *ApplicationDiscoveryService) StopDataCollectionByAgentIdsRequest(input *StopDataCollectionByAgentIdsInput) (req *request.Request, output *StopDataCollectionByAgentIdsOutput)
StopDataCollectionByAgentIdsRequest generates a request for the StopDataCollectionByAgentIds operation.
type Attribute ¶
type Attribute struct { // The name of the attribute. Name *string `type:"string"` // A specific attribute type. For example key = serverType and value = web server. Value *string `type:"string"` // contains filtered or unexported fields }
A specific detail about a configuration item. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
type ConfigurationTag ¶
type ConfigurationTag struct { // The configuration ID for the item you want to tag. You can specify a list // of keys and values. ConfigurationId *string `locationName:"configurationId" type:"string"` // A descriptor. For example, serverType. ConfigurationType *string `locationName:"configurationType" type:"string" enum:"ConfigurationItemType"` // A type of tag to filter on. For example serverType. Key *string `locationName:"key" type:"string"` // A value to filter on. For example key = serverType and value = web server. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
Tags for a configuration item. Tags are metadata that help you categorize IT assets.
func (ConfigurationTag) GoString ¶
func (s ConfigurationTag) GoString() string
GoString returns the string representation
func (ConfigurationTag) String ¶
func (s ConfigurationTag) String() string
String returns the string representation
type CreateTagsInput ¶
type CreateTagsInput struct { // A list of configuration items that you want to tag. ConfigurationIds []*string `locationName:"configurationIds" type:"list" required:"true"` // Tags that you want to associate with one or more configuration items. Specify // the tags that you want to create in a key,value format. For example: // // {"key": "serverType", "value": "webServer"} Tags []*Tag `locationName:"tags" locationNameList:"item" type:"list" required:"true"` // contains filtered or unexported fields }
func (CreateTagsInput) GoString ¶
func (s CreateTagsInput) GoString() string
GoString returns the string representation
func (CreateTagsInput) String ¶
func (s CreateTagsInput) String() string
String returns the string representation
func (*CreateTagsInput) Validate ¶
func (s *CreateTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateTagsOutput ¶
type CreateTagsOutput struct {
// contains filtered or unexported fields
}
func (CreateTagsOutput) GoString ¶
func (s CreateTagsOutput) GoString() string
GoString returns the string representation
func (CreateTagsOutput) String ¶
func (s CreateTagsOutput) String() string
String returns the string representation
type DeleteTagsInput ¶
type DeleteTagsInput struct { // A list of configuration items with tags that you want to delete. ConfigurationIds []*string `locationName:"configurationIds" type:"list" required:"true"` // Tags that you want to delete from one or more configuration items. Specify // the tags that you want to delete in a key, value format. For example: // // {"key": "serverType", "value": "webServer"} Tags []*Tag `locationName:"tags" locationNameList:"item" type:"list"` // contains filtered or unexported fields }
func (DeleteTagsInput) GoString ¶
func (s DeleteTagsInput) GoString() string
GoString returns the string representation
func (DeleteTagsInput) String ¶
func (s DeleteTagsInput) String() string
String returns the string representation
func (*DeleteTagsInput) Validate ¶
func (s *DeleteTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTagsOutput ¶
type DeleteTagsOutput struct {
// contains filtered or unexported fields
}
func (DeleteTagsOutput) GoString ¶
func (s DeleteTagsOutput) GoString() string
GoString returns the string representation
func (DeleteTagsOutput) String ¶
func (s DeleteTagsOutput) String() string
String returns the string representation
type DescribeAgentsInput ¶
type DescribeAgentsInput struct { // The agent IDs for which you want information. If you specify no IDs, the // system returns information about all agents associated with your AWS user // account. AgentIds []*string `locationName:"agentIds" type:"list"` // The total number of items to return. The maximum value is 100. MaxResults *int64 `locationName:"maxResults" type:"integer"` // A token to start the list. Use this token to get the next set of results. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (DescribeAgentsInput) GoString ¶
func (s DescribeAgentsInput) GoString() string
GoString returns the string representation
func (DescribeAgentsInput) String ¶
func (s DescribeAgentsInput) String() string
String returns the string representation
type DescribeAgentsOutput ¶
type DescribeAgentsOutput struct { // Lists AWS agents by ID or lists all agents associated with your user account // if you did not specify an agent ID. The output includes agent IDs, IP addresses, // MAC addresses, agent health, host name where the agent resides, and the version // number of each agent. AgentsInfo []*AgentInfo `locationName:"agentsInfo" type:"list"` // The call returns a token. Use this token to get the next set of results. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (DescribeAgentsOutput) GoString ¶
func (s DescribeAgentsOutput) GoString() string
GoString returns the string representation
func (DescribeAgentsOutput) String ¶
func (s DescribeAgentsOutput) String() string
String returns the string representation
type DescribeTagsInput ¶
type DescribeTagsInput struct { // You can filter the list using a key, value format. For example: // // {"key": "serverType", "value": "webServer"} // // You can separate these items by using logical operators. Allowed filters // include tagkey, tagValue, and configid. Filter []*TagFilter `locationName:"filter" type:"list"` // The total number of items to return. The maximum value is 100. MaxResults *int64 `locationName:"maxResults" type:"integer"` // A token to start the list. Use this token to get the next set of results. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (DescribeTagsInput) GoString ¶
func (s DescribeTagsInput) GoString() string
GoString returns the string representation
func (DescribeTagsInput) String ¶
func (s DescribeTagsInput) String() string
String returns the string representation
func (*DescribeTagsInput) Validate ¶
func (s *DescribeTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTagsOutput ¶
type DescribeTagsOutput struct { // The call returns a token. Use this token to get the next set of results. NextToken *string `locationName:"nextToken" type:"string"` // Depending on the input, a list of configuration items tagged with a specific // tag, or a list of tags for a specific configuration item. Tags []*ConfigurationTag `locationName:"tags" locationNameList:"item" type:"list"` // contains filtered or unexported fields }
func (DescribeTagsOutput) GoString ¶
func (s DescribeTagsOutput) GoString() string
GoString returns the string representation
func (DescribeTagsOutput) String ¶
func (s DescribeTagsOutput) String() string
String returns the string representation
type ExportConfigurationsInput ¶
type ExportConfigurationsInput struct {
// contains filtered or unexported fields
}
func (ExportConfigurationsInput) GoString ¶
func (s ExportConfigurationsInput) GoString() string
GoString returns the string representation
func (ExportConfigurationsInput) String ¶
func (s ExportConfigurationsInput) String() string
String returns the string representation
type ExportConfigurationsOutput ¶
type ExportConfigurationsOutput struct { // A unique identifier which you can use to query the export status. ExportId *string `locationName:"exportId" type:"string"` // contains filtered or unexported fields }
func (ExportConfigurationsOutput) GoString ¶
func (s ExportConfigurationsOutput) GoString() string
GoString returns the string representation
func (ExportConfigurationsOutput) String ¶
func (s ExportConfigurationsOutput) String() string
String returns the string representation
type Filter ¶
type Filter struct { // A conditional operator for the filter. Condition *string `locationName:"condition" type:"string" required:"true"` // The name of the filter you want to use. Name *string `locationName:"name" type:"string" required:"true"` // The value you want to filter on. Values []*string `locationName:"values" locationNameList:"item" type:"list" required:"true"` // contains filtered or unexported fields }
A means of limiting responses.
type GetConfigurationAttributesInput ¶
type GetConfigurationAttributesInput struct { // One or more configuration IDs. ConfigurationIds []*string `locationName:"configurationIds" type:"list" required:"true"` // contains filtered or unexported fields }
func (GetConfigurationAttributesInput) GoString ¶
func (s GetConfigurationAttributesInput) GoString() string
GoString returns the string representation
func (GetConfigurationAttributesInput) String ¶
func (s GetConfigurationAttributesInput) String() string
String returns the string representation
func (*GetConfigurationAttributesInput) Validate ¶
func (s *GetConfigurationAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetConfigurationAttributesOutput ¶
type GetConfigurationAttributesOutput struct { // Returns configuration details, including the configuration ID, attribute // names, and attribute values. Configurations map[string][]*Attribute `locationName:"configurations" type:"map"` // contains filtered or unexported fields }
func (GetConfigurationAttributesOutput) GoString ¶
func (s GetConfigurationAttributesOutput) GoString() string
GoString returns the string representation
func (GetConfigurationAttributesOutput) String ¶
func (s GetConfigurationAttributesOutput) String() string
String returns the string representation
type GetExportStatusInput ¶
type GetExportStatusInput struct { // A unique identifier which you can use to query the export status. ExportId *string `locationName:"exportId" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetExportStatusInput) GoString ¶
func (s GetExportStatusInput) GoString() string
GoString returns the string representation
func (GetExportStatusInput) String ¶
func (s GetExportStatusInput) String() string
String returns the string representation
func (*GetExportStatusInput) Validate ¶
func (s *GetExportStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetExportStatusOutput ¶
type GetExportStatusOutput struct { // Returns configuration details, including the configuration ID, attribute // names, and attribute values. ExportId *string `locationName:"exportId" type:"string"` // Returns export details. When the status is complete, the response includes // a URL for an Amazon S3 bucket where you can view the data in a CSV file. ExportStatusMap map[string]*string `locationName:"exportStatusMap" type:"map"` // contains filtered or unexported fields }
func (GetExportStatusOutput) GoString ¶
func (s GetExportStatusOutput) GoString() string
GoString returns the string representation
func (GetExportStatusOutput) String ¶
func (s GetExportStatusOutput) String() string
String returns the string representation
type ListConfigurationsInput ¶
type ListConfigurationsInput struct { // A valid configuration identified by the Discovery Service. ConfigurationType *string `locationName:"configurationType" type:"string" required:"true" enum:"ConfigurationItemType"` // You can filter the list using a key, value format. For example: // // {"key": "serverType", "value": "webServer"} Filters []*Filter `locationName:"filters" type:"list"` // The total number of items to return. The maximum value is 100. MaxResults *int64 `locationName:"maxResults" type:"integer"` // A token to start the list. Use this token to get the next set of results. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListConfigurationsInput) GoString ¶
func (s ListConfigurationsInput) GoString() string
GoString returns the string representation
func (ListConfigurationsInput) String ¶
func (s ListConfigurationsInput) String() string
String returns the string representation
func (*ListConfigurationsInput) Validate ¶
func (s *ListConfigurationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListConfigurationsOutput ¶
type ListConfigurationsOutput struct { // Returns a list of configuration item IDs. Configurations []map[string]*string `locationName:"configurations" type:"list"` // The call returns a token. Use this token to get the next set of results. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListConfigurationsOutput) GoString ¶
func (s ListConfigurationsOutput) GoString() string
GoString returns the string representation
func (ListConfigurationsOutput) String ¶
func (s ListConfigurationsOutput) String() string
String returns the string representation
type RemoveConfigurationInput ¶
type RemoveConfigurationInput struct { ConfigurationId *string `locationName:"configurationId" type:"string" required:"true"` // contains filtered or unexported fields }
func (RemoveConfigurationInput) GoString ¶
func (s RemoveConfigurationInput) GoString() string
GoString returns the string representation
func (RemoveConfigurationInput) String ¶
func (s RemoveConfigurationInput) String() string
String returns the string representation
func (*RemoveConfigurationInput) Validate ¶
func (s *RemoveConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemoveConfigurationOutput ¶
type RemoveConfigurationOutput struct {
// contains filtered or unexported fields
}
func (RemoveConfigurationOutput) GoString ¶
func (s RemoveConfigurationOutput) GoString() string
GoString returns the string representation
func (RemoveConfigurationOutput) String ¶
func (s RemoveConfigurationOutput) String() string
String returns the string representation
type StartDataCollectionByAgentIdsInput ¶
type StartDataCollectionByAgentIdsInput struct { // The IDs of the agents that you want to start collecting data. AgentIds []*string `locationName:"agentIds" type:"list" required:"true"` // contains filtered or unexported fields }
func (StartDataCollectionByAgentIdsInput) GoString ¶
func (s StartDataCollectionByAgentIdsInput) GoString() string
GoString returns the string representation
func (StartDataCollectionByAgentIdsInput) String ¶
func (s StartDataCollectionByAgentIdsInput) String() string
String returns the string representation
func (*StartDataCollectionByAgentIdsInput) Validate ¶
func (s *StartDataCollectionByAgentIdsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartDataCollectionByAgentIdsOutput ¶
type StartDataCollectionByAgentIdsOutput struct { // Information about agents that were instructed to start collecting data. Information // includes the agent ID, a description of the operation performed, and whether // or not the agent configuration was updated. AgentsConfigStatus []*AgentConfigStatus `locationName:"agentsConfigStatus" type:"list"` // contains filtered or unexported fields }
func (StartDataCollectionByAgentIdsOutput) GoString ¶
func (s StartDataCollectionByAgentIdsOutput) GoString() string
GoString returns the string representation
func (StartDataCollectionByAgentIdsOutput) String ¶
func (s StartDataCollectionByAgentIdsOutput) String() string
String returns the string representation
type StopDataCollectionByAgentIdsInput ¶
type StopDataCollectionByAgentIdsInput struct { // The IDs of the agents that you want to stop collecting data. AgentIds []*string `locationName:"agentIds" type:"list" required:"true"` // contains filtered or unexported fields }
func (StopDataCollectionByAgentIdsInput) GoString ¶
func (s StopDataCollectionByAgentIdsInput) GoString() string
GoString returns the string representation
func (StopDataCollectionByAgentIdsInput) String ¶
func (s StopDataCollectionByAgentIdsInput) String() string
String returns the string representation
func (*StopDataCollectionByAgentIdsInput) Validate ¶
func (s *StopDataCollectionByAgentIdsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopDataCollectionByAgentIdsOutput ¶
type StopDataCollectionByAgentIdsOutput struct { // Information about agents that were instructed to stop collecting data. Information // includes the agent ID, a description of the operation performed, and whether // or not the agent configuration was updated. AgentsConfigStatus []*AgentConfigStatus `locationName:"agentsConfigStatus" type:"list"` // contains filtered or unexported fields }
func (StopDataCollectionByAgentIdsOutput) GoString ¶
func (s StopDataCollectionByAgentIdsOutput) GoString() string
GoString returns the string representation
func (StopDataCollectionByAgentIdsOutput) String ¶
func (s StopDataCollectionByAgentIdsOutput) String() string
String returns the string representation
type Tag ¶
type Tag struct { // A type of tag to filter on. Key *string `locationName:"key" type:"string" required:"true"` // A value for a tag key to filter on. Value *string `locationName:"value" type:"string" required:"true"` // contains filtered or unexported fields }
Metadata that help you categorize IT assets.
type TagFilter ¶
type TagFilter struct { // A name of a tag filter. Name *string `type:"string" required:"true"` // Values of a tag filter. Values []*string `locationNameList:"item" type:"list" required:"true"` // contains filtered or unexported fields }
A means of limiting responses when searching for tags.
Directories ¶
Path | Synopsis |
---|---|
Package applicationdiscoveryserviceiface provides an interface for the AWS Application Discovery Service.
|
Package applicationdiscoveryserviceiface provides an interface for the AWS Application Discovery Service. |