applicationdiscoveryservice

package
v1.1.31 Latest Latest
Warning

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

 Go to latest Published: May 26, 2016 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package applicationdiscoveryservice provides a client for AWS Application Discovery Service.

Index

Examples

Constants

View Source 
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"
)
View Source 
const (
	// @enum ConfigurationItemType
	ConfigurationItemTypeServer = "SERVER"
	// @enum ConfigurationItemType
	ConfigurationItemTypeProcess = "PROCESS"
	// @enum ConfigurationItemType
	ConfigurationItemTypeConnection = "CONNECTION"
)
View Source 
const (
	// @enum ExportStatus
	ExportStatusFailed = "FAILED"
	// @enum ExportStatus
	ExportStatusSucceeded = "SUCCEEDED"
	// @enum ExportStatus
	ExportStatusInProgress = "IN_PROGRESS"
)
View Source 
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 AgentConfigurationStatus added in v1.1.27 

type AgentConfigurationStatus struct {

	// The agent ID.
	AgentId *string `locationName:"agentId" type:"string"`

	// A description of the operation performed.
	Description *string `locationName:"description" type:"string"`

	// Information about the status of the StartDataCollection and StopDataCollection
	// operations. The system has recorded the data collection operation. The agent
	// receives this command the next time it polls for a new command.
	OperationSucceeded *bool `locationName:"operationSucceeded" type:"boolean"`
	// 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 (AgentConfigurationStatus) GoString added in v1.1.27 

func (s AgentConfigurationStatus) GoString() string

GoString returns the string representation

func (AgentConfigurationStatus) String added in v1.1.27 

func (s AgentConfigurationStatus) 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"`

	// This data type is currently not valid.
	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 or
	// virtual machine.
	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, media access control (MAC) addresses, agent health, hostname where the agent resides, and agent version for each agent.

func (AgentInfo) GoString 

func (s AgentInfo) GoString() string

GoString returns the string representation

func (AgentInfo) String 

func (s AgentInfo) String() string

String returns the string representation

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 

type ApplicationDiscoveryService struct {
	*client.Client
}

The AWS Application Discovery Service helps Systems Integrators quickly and reliably plan application migration projects by automatically identifying applications running in on-premises data centers, their associated dependencies, and their performance profile. 

Planning data center migrations can involve thousands of workloads that

are often deeply interdependent. Application discovery and dependency mapping are important early first steps in the migration process, but difficult to perform at scale due to the lack of automated tools.

The AWS Application Discovery Service automatically collects configuration and usage data from servers to develop a list of applications, how they perform, and how they are interdependent. This information is securely retained in an AWS Application Discovery Service database which you can export as a CSV file into your preferred visualization tool or cloud migration solution to help reduce the complexity and time in planning your cloud migration.

The Application Discovery Service is currently available for preview. Only customers who are engaged with AWS Professional Services (https://aws.amazon.com/professional-services/) or a certified AWS partner can use the service. To see the list of certified partners and request access to the Application Discovery Service, complete the following preview form (http://aws.amazon.com/application-discovery/preview/).

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 is 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/application-discovery/latest/userguide/what-is-appdiscovery.html).

The following are short descriptions of each API action, organized by function. 

Managing AWS Agents Using the Application Discovery Service

An AWS agent is software that you install on on-premises servers and virtual machines that are targeted for discovery and migration. Agents run on Linux and Windows Server and collect server configuration and activity information about your applications and infrastructure. Specifically, agents collect the following information and send it to the Application Discovery Service using Secure Sockets Layer (SSL) encryption: 

User information (user name, home directory)

Group information (name)

List of installed packages

List of kernel modules

All create and stop process events

DNS queries

NIC information

TCP/UDP process listening ports

TCPV4/V6 connections

Operating system information

System performance

Process performance

The Application Discovery Service API includes the following actions to

manage AWS agents: 

StartDataCollectionByAgentIds: Instructs the specified agents to start

collecting data. The Application Discovery Service takes several minutes to receive and process data after you initiate data collection. 

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, media access control (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. When you use the Application Discovery Service, you can specify filters and query specific configuration items. The service supports Server, Process, and Connection configuration items. This means you can specify a value for the following keys and query your IT assets: 

Server    server.HostName

 server.osName

 server.osVersion

 server.configurationId

 server.agentId

  Process    process.name

 process.CommandLine

 process.configurationId

 server.hostName

 server.osName

 server.osVersion

 server.configurationId

 server.agentId

  Connection    connection.sourceIp

 connection.sourcePort

 connection.destinationIp

 connection.destinationPort

 sourceProcess.configurationId

 sourceProcess.commandLine

 sourceProcess.name

 destinationProcessId.configurationId

 destinationProcess.commandLine

 destinationProcess.name

 sourceServer.configurationId

 sourceServer.hostName

 sourceServer.osName

 sourceServer.osVersion

 destinationServer.configurationId

 destinationServer.hostName

 destinationServer.osName

 destinationServer.osVersion

 The Application Discovery Service includes the following actions for querying

configuration items. 

DescribeConfigurations: 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 configuration items according

to the criteria you specify in a filter. The filter criteria identify relationship requirements. For example, you can specify filter criteria of process.name with values of nginx and apache. 

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 items.

DescribeTags: Retrieves a list of configuration items that are tagged

with a specific tag. Or, retrieves a list of all tags assigned to a specific configuration item. 

DeleteTags: Deletes the association between a configuration item and

one or more tags. 

Exporting Data

You can export data as a CSV file to an Amazon S3 bucket or into your preferred visualization tool or cloud migration solution to help reduce the complexity and time in planning your cloud migration. 

ExportConfigurations: Exports all discovered configuration data to an

Amazon S3 bucket. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID which you can query using the GetExportStatus API. 

DescribeExportConfigurations: 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 configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.

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 the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.

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) DescribeConfigurations added in v1.1.27 

func (c *ApplicationDiscoveryService) DescribeConfigurations(input *DescribeConfigurationsInput) (*DescribeConfigurationsOutput, error)

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.

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.DescribeConfigurationsInput{
		ConfigurationIds: []*string{ // Required
			aws.String("ConfigurationId"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeConfigurations(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) DescribeConfigurationsRequest added in v1.1.27 

func (c *ApplicationDiscoveryService) DescribeConfigurationsRequest(input *DescribeConfigurationsInput) (req *request.Request, output *DescribeConfigurationsOutput)

DescribeConfigurationsRequest generates a request for the DescribeConfigurations operation.

func (*ApplicationDiscoveryService) DescribeExportConfigurations added in v1.1.27 

func (c *ApplicationDiscoveryService) DescribeExportConfigurations(input *DescribeExportConfigurationsInput) (*DescribeExportConfigurationsOutput, error)

Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.

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.DescribeExportConfigurationsInput{
		ExportIds: []*string{
			aws.String("ConfigurationsExportId"), // Required
			// More values...
		},
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.DescribeExportConfigurations(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) DescribeExportConfigurationsRequest added in v1.1.27 

func (c *ApplicationDiscoveryService) DescribeExportConfigurationsRequest(input *DescribeExportConfigurationsInput) (req *request.Request, output *DescribeExportConfigurationsOutput)

DescribeExportConfigurationsRequest generates a request for the DescribeExportConfigurations operation.

func (*ApplicationDiscoveryService) DescribeTags 

func (c *ApplicationDiscoveryService) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)

Retrieves a list of configuration items that are tagged with a specific tag. Or retrieves a list of 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{
		Filters: []*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 all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID which you can query using the GetExportStatus API. The system imposes a limit of two configuration exports in six hours.

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) ListConfigurations 

func (c *ApplicationDiscoveryService) ListConfigurations(input *ListConfigurationsInput) (*ListConfigurationsOutput, error)

Retrieves 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) 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.

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 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 type of IT asset that you want to tag.
	ConfigurationType *string `locationName:"configurationType" type:"string" enum:"ConfigurationItemType"`

	// A type of tag to filter on. For example, serverType.
	Key *string `locationName:"key" type:"string"`

	// The time the configuration tag was created in Coordinated Universal Time
	// (UTC).
	TimeOfCreation *time.Time `locationName:"timeOfCreation" type:"timestamp" timestampFormat:"unix"`

	// 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 agents 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,
	// media access control (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 DescribeConfigurationsInput added in v1.1.27 

type DescribeConfigurationsInput struct {

	// One or more configuration IDs.
	ConfigurationIds []*string `locationName:"configurationIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeConfigurationsInput) GoString added in v1.1.27 

func (s DescribeConfigurationsInput) GoString() string

GoString returns the string representation

func (DescribeConfigurationsInput) String added in v1.1.27 

func (s DescribeConfigurationsInput) String() string

String returns the string representation

func (*DescribeConfigurationsInput) Validate added in v1.1.27 

func (s *DescribeConfigurationsInput) Validate() error

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

type DescribeConfigurationsOutput added in v1.1.27 

type DescribeConfigurationsOutput struct {

	// A key in the response map. The value is an array of data.
	Configurations []map[string]*string `locationName:"configurations" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeConfigurationsOutput) GoString added in v1.1.27 

func (s DescribeConfigurationsOutput) GoString() string

GoString returns the string representation

func (DescribeConfigurationsOutput) String added in v1.1.27 

func (s DescribeConfigurationsOutput) String() string

String returns the string representation

type DescribeExportConfigurationsInput added in v1.1.27 

type DescribeExportConfigurationsInput struct {

	// A unique identifier that you can use to query the export status.
	ExportIds []*string `locationName:"exportIds" type:"list"`

	// The maximum number of results that you want to display as a part of the query.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// A token to get the next set of results. For example, if you specified 100
	// IDs for DescribeConfigurationsRequest$configurationIds but set DescribeExportConfigurationsRequest$maxResults
	// to 10, you will get results in a set of 10. Use the token in the query to
	// get the next set of 10.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExportConfigurationsInput) GoString added in v1.1.27 

func (s DescribeExportConfigurationsInput) GoString() string

GoString returns the string representation

func (DescribeExportConfigurationsInput) String added in v1.1.27 

func (s DescribeExportConfigurationsInput) String() string

String returns the string representation

type DescribeExportConfigurationsOutput added in v1.1.27 

type DescribeExportConfigurationsOutput struct {

	// 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.
	ExportsInfo []*ExportInfo `locationName:"exportsInfo" type:"list"`

	// A token to get the next set of results. For example, if you specified 100
	// IDs for DescribeConfigurationsRequest$configurationIds but set DescribeExportConfigurationsRequest$maxResults
	// to 10, you will get results in a set of 10. Use the token in the query to
	// get the next set of 10.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExportConfigurationsOutput) GoString added in v1.1.27 

func (s DescribeExportConfigurationsOutput) GoString() string

GoString returns the string representation

func (DescribeExportConfigurationsOutput) String added in v1.1.27 

func (s DescribeExportConfigurationsOutput) String() string

String returns the string representation

type DescribeTagsInput 

type DescribeTagsInput struct {

	// You can filter the list using a key-value format. You can separate these
	// items by using logical operators. Allowed filters include tagKey, tagValue,
	// and configurationId.
	Filters []*TagFilter `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 (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, this is 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 that 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 ExportInfo added in v1.1.27 

type ExportInfo struct {

	// A URL for an Amazon S3 bucket where you can review the configuration data.
	// The URL is displayed only if the export succeeded.
	ConfigurationsDownloadUrl *string `locationName:"configurationsDownloadUrl" type:"string"`

	// A unique identifier that you can use to query the export.
	ExportId *string `locationName:"exportId" type:"string" required:"true"`

	// The time the configuration data export was initiated.
	ExportRequestTime *time.Time `locationName:"exportRequestTime" type:"timestamp" timestampFormat:"unix" required:"true"`

	// The status of the configuration data export. The status can succeed, fail,
	// or be in-progress.
	ExportStatus *string `locationName:"exportStatus" type:"string" required:"true" enum:"ExportStatus"`

	// Helpful status messages for API callers. For example: Too many exports in
	// the last 6 hours. Export in progress. Export was successful.
	StatusMessage *string `locationName:"statusMessage" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information regarding the export status of the discovered data. The value is an array of objects.

func (ExportInfo) GoString added in v1.1.27 

func (s ExportInfo) GoString() string

GoString returns the string representation

func (ExportInfo) String added in v1.1.27 

func (s ExportInfo) String() string

String returns the string representation

type Filter 

type Filter struct {

	// A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS,
	// CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes
	// all filters as though concatenated by AND. If you specify multiple values
	// for a particular filter, the system differentiates the values using OR. Calling
	// either DescribeConfigurations or ListConfigurations returns attributes of
	// matching configuration items.
	Condition *string `locationName:"condition" type:"string" required:"true"`

	// The name of the filter. The following filter names are allowed for SERVER
	// configuration items.
	//
	//  Server     server.hostName
	//
	//    server.osName
	//
	//    server.osVersion
	//
	//    server.configurationid
	//
	//    server.agentid
	//
	//   The name of the filter. The following filter names are allowed for PROCESS
	// configuration items.
	//
	//  Process     process.configurationid
	//
	//    process.name
	//
	//    process.commandLine
	//
	//    server.configurationid
	//
	//    server.hostName
	//
	//    server.osName
	//
	//    server.osVersion
	//
	//    server.agentId
	//
	//   The name of the filter. The following filter names are allowed for CONNECTION
	// configuration items.
	//
	//  Connection     connection.sourceIp
	//
	//    connection.destinationIp
	//
	//    connection.destinationPort
	//
	//    sourceProcess.configurationId
	//
	//    sourceProcess.name
	//
	//    sourceProcess.commandLine
	//
	//    destinationProcess.configurationId
	//
	//    destinationProcess.name
	//
	//    destinationProcess.commandLine
	//
	//    sourceServer.configurationId
	//
	//    sourceServer.hostName
	//
	//    sourceServer.osName
	//
	//    sourceServer.osVersion
	//
	//    sourceServer.agentId
	//
	//    destinationServer.configurationId
	//
	//    destinationServer.hostName
	//
	//    destinationServer.osName
	//
	//    destinationServer.osVersion
	//
	//    destinationServer.agentId
	Name *string `locationName:"name" type:"string" required:"true"`

	// A string value that you want to filter on. For example, if you choose the
	// destinationServer.osVersion filter name, you could specify Ubuntu for the
	// value.
	Values []*string `locationName:"values" locationNameList:"item" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A filter that can use conditional operators.

func (Filter) GoString 

func (s Filter) GoString() string

GoString returns the string representation

func (Filter) String 

func (s Filter) String() string

String returns the string representation

func (*Filter) Validate 

func (s *Filter) Validate() error

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

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"}
	//
	// You can separate these items by using logical operators.
	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 configuration details, including the configuration ID, attribute
	// names, and attribute values.
	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 StartDataCollectionByAgentIdsInput 

type StartDataCollectionByAgentIdsInput struct {

	// The IDs of the agents that you want to start collecting data. If you send
	// a request to an AWS agent ID that you do not have permission to contact,
	// according to your AWS account, the service does not throw an exception. Instead,
	// it returns the error in the Description field. If you send a request to multiple
	// agents and you do not have permission to contact some of those agents, the
	// system does not throw an exception. Instead, the system shows Failed in the
	// Description field.
	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.
	AgentsConfigurationStatus []*AgentConfigurationStatus `locationName:"agentsConfigurationStatus" 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.
	AgentsConfigurationStatus []*AgentConfigurationStatus `locationName:"agentsConfigurationStatus" 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.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

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

type TagFilter 

type TagFilter struct {

	// A name of a tag filter.
	Name *string `locationName:"name" type:"string" required:"true"`

	// Values of a tag filter.
	Values []*string `locationName:"values" locationNameList:"item" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The name of a tag filter. Valid names are: tagKey, tagValue, configurationId.

func (TagFilter) GoString 

func (s TagFilter) GoString() string

GoString returns the string representation

func (TagFilter) String 

func (s TagFilter) String() string

String returns the string representation

func (*TagFilter) Validate 

func (s *TagFilter) Validate() error

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

Source Files

View all Source files

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.