Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AWSLocation

type AWSLocation struct {

	// The Amazon Resource Name (ARN) of the subnet the device is located in.
	SubnetArn *string

	// The Zone the device is located in. This can be the ID of an Availability Zone,
	// Local Zone, Wavelength Zone, or an Outpost.
	Zone *string
}

    Specifies a location in AWS.

    type AccessDeniedException

    type AccessDeniedException struct {
    	Message *string
    }

      You do not have sufficient access to perform this action.

      func (*AccessDeniedException) Error

      func (e *AccessDeniedException) Error() string

      func (*AccessDeniedException) ErrorCode

      func (e *AccessDeniedException) ErrorCode() string

      func (*AccessDeniedException) ErrorFault

      func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

      func (*AccessDeniedException) ErrorMessage

      func (e *AccessDeniedException) ErrorMessage() string

      type Bandwidth

      type Bandwidth struct {
      
      	// Download speed in Mbps.
      	DownloadSpeed *int32
      
      	// Upload speed in Mbps.
      	UploadSpeed *int32
      }

        Describes bandwidth information.

        type ConflictException

        type ConflictException struct {
        	Message *string
        
        	ResourceId   *string
        	ResourceType *string
        }

          There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

          func (*ConflictException) Error

          func (e *ConflictException) Error() string

          func (*ConflictException) ErrorCode

          func (e *ConflictException) ErrorCode() string

          func (*ConflictException) ErrorFault

          func (e *ConflictException) ErrorFault() smithy.ErrorFault

          func (*ConflictException) ErrorMessage

          func (e *ConflictException) ErrorMessage() string

          type Connection

          type Connection struct {
          
          	// The ID of the second device in the connection.
          	ConnectedDeviceId *string
          
          	// The ID of the link for the second device in the connection.
          	ConnectedLinkId *string
          
          	// The Amazon Resource Name (ARN) of the connection.
          	ConnectionArn *string
          
          	// The ID of the connection.
          	ConnectionId *string
          
          	// The date and time that the connection was created.
          	CreatedAt *time.Time
          
          	// The description of the connection.
          	Description *string
          
          	// The ID of the first device in the connection.
          	DeviceId *string
          
          	// The ID of the global network.
          	GlobalNetworkId *string
          
          	// The ID of the link for the first device in the connection.
          	LinkId *string
          
          	// The state of the connection.
          	State ConnectionState
          
          	// The tags for the connection.
          	Tags []Tag
          }

            Describes a connection.

            type ConnectionState

            type ConnectionState string
            const (
            	ConnectionStatePending   ConnectionState = "PENDING"
            	ConnectionStateAvailable ConnectionState = "AVAILABLE"
            	ConnectionStateDeleting  ConnectionState = "DELETING"
            	ConnectionStateUpdating  ConnectionState = "UPDATING"
            )

              Enum values for ConnectionState

              func (ConnectionState) Values

              func (ConnectionState) Values() []ConnectionState

                Values returns all known values for ConnectionState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                type CustomerGatewayAssociation

                type CustomerGatewayAssociation struct {
                
                	// The Amazon Resource Name (ARN) of the customer gateway.
                	CustomerGatewayArn *string
                
                	// The ID of the device.
                	DeviceId *string
                
                	// The ID of the global network.
                	GlobalNetworkId *string
                
                	// The ID of the link.
                	LinkId *string
                
                	// The association state.
                	State CustomerGatewayAssociationState
                }

                  Describes the association between a customer gateway, a device, and a link.

                  type CustomerGatewayAssociationState

                  type CustomerGatewayAssociationState string
                  const (
                  	CustomerGatewayAssociationStatePending   CustomerGatewayAssociationState = "PENDING"
                  	CustomerGatewayAssociationStateAvailable CustomerGatewayAssociationState = "AVAILABLE"
                  	CustomerGatewayAssociationStateDeleting  CustomerGatewayAssociationState = "DELETING"
                  	CustomerGatewayAssociationStateDeleted   CustomerGatewayAssociationState = "DELETED"
                  )

                    Enum values for CustomerGatewayAssociationState

                    func (CustomerGatewayAssociationState) Values

                      Values returns all known values for CustomerGatewayAssociationState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                      type Device

                      type Device struct {
                      
                      	// The AWS location of the device.
                      	AWSLocation *AWSLocation
                      
                      	// The date and time that the site was created.
                      	CreatedAt *time.Time
                      
                      	// The description of the device.
                      	Description *string
                      
                      	// The Amazon Resource Name (ARN) of the device.
                      	DeviceArn *string
                      
                      	// The ID of the device.
                      	DeviceId *string
                      
                      	// The ID of the global network.
                      	GlobalNetworkId *string
                      
                      	// The site location.
                      	Location *Location
                      
                      	// The device model.
                      	Model *string
                      
                      	// The device serial number.
                      	SerialNumber *string
                      
                      	// The site ID.
                      	SiteId *string
                      
                      	// The device state.
                      	State DeviceState
                      
                      	// The tags for the device.
                      	Tags []Tag
                      
                      	// The device type.
                      	Type *string
                      
                      	// The device vendor.
                      	Vendor *string
                      }

                        Describes a device.

                        type DeviceState

                        type DeviceState string
                        const (
                        	DeviceStatePending   DeviceState = "PENDING"
                        	DeviceStateAvailable DeviceState = "AVAILABLE"
                        	DeviceStateDeleting  DeviceState = "DELETING"
                        	DeviceStateUpdating  DeviceState = "UPDATING"
                        )

                          Enum values for DeviceState

                          func (DeviceState) Values

                          func (DeviceState) Values() []DeviceState

                            Values returns all known values for DeviceState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                            type GlobalNetwork

                            type GlobalNetwork struct {
                            
                            	// The date and time that the global network was created.
                            	CreatedAt *time.Time
                            
                            	// The description of the global network.
                            	Description *string
                            
                            	// The Amazon Resource Name (ARN) of the global network.
                            	GlobalNetworkArn *string
                            
                            	// The ID of the global network.
                            	GlobalNetworkId *string
                            
                            	// The state of the global network.
                            	State GlobalNetworkState
                            
                            	// The tags for the global network.
                            	Tags []Tag
                            }

                              Describes a global network.

                              type GlobalNetworkState

                              type GlobalNetworkState string
                              const (
                              	GlobalNetworkStatePending   GlobalNetworkState = "PENDING"
                              	GlobalNetworkStateAvailable GlobalNetworkState = "AVAILABLE"
                              	GlobalNetworkStateDeleting  GlobalNetworkState = "DELETING"
                              	GlobalNetworkStateUpdating  GlobalNetworkState = "UPDATING"
                              )

                                Enum values for GlobalNetworkState

                                func (GlobalNetworkState) Values

                                  Values returns all known values for GlobalNetworkState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                  type InternalServerException

                                  type InternalServerException struct {
                                  	Message *string
                                  
                                  	RetryAfterSeconds *int32
                                  }

                                    The request has failed due to an internal error.

                                    func (*InternalServerException) Error

                                    func (e *InternalServerException) Error() string

                                    func (*InternalServerException) ErrorCode

                                    func (e *InternalServerException) ErrorCode() string

                                    func (*InternalServerException) ErrorFault

                                    func (e *InternalServerException) ErrorFault() smithy.ErrorFault

                                    func (*InternalServerException) ErrorMessage

                                    func (e *InternalServerException) ErrorMessage() string
                                    type Link struct {
                                    
                                    	// The bandwidth for the link.
                                    	Bandwidth *Bandwidth
                                    
                                    	// The date and time that the link was created.
                                    	CreatedAt *time.Time
                                    
                                    	// The description of the link.
                                    	Description *string
                                    
                                    	// The ID of the global network.
                                    	GlobalNetworkId *string
                                    
                                    	// The Amazon Resource Name (ARN) of the link.
                                    	LinkArn *string
                                    
                                    	// The ID of the link.
                                    	LinkId *string
                                    
                                    	// The provider of the link.
                                    	Provider *string
                                    
                                    	// The ID of the site.
                                    	SiteId *string
                                    
                                    	// The state of the link.
                                    	State LinkState
                                    
                                    	// The tags for the link.
                                    	Tags []Tag
                                    
                                    	// The type of the link.
                                    	Type *string
                                    }

                                      Describes a link.

                                      type LinkAssociation

                                      type LinkAssociation struct {
                                      
                                      	// The device ID for the link association.
                                      	DeviceId *string
                                      
                                      	// The ID of the global network.
                                      	GlobalNetworkId *string
                                      
                                      	// The state of the association.
                                      	LinkAssociationState LinkAssociationState
                                      
                                      	// The ID of the link.
                                      	LinkId *string
                                      }

                                        Describes the association between a device and a link.

                                        type LinkAssociationState

                                        type LinkAssociationState string
                                        const (
                                        	LinkAssociationStatePending   LinkAssociationState = "PENDING"
                                        	LinkAssociationStateAvailable LinkAssociationState = "AVAILABLE"
                                        	LinkAssociationStateDeleting  LinkAssociationState = "DELETING"
                                        	LinkAssociationStateDeleted   LinkAssociationState = "DELETED"
                                        )

                                          Enum values for LinkAssociationState

                                          func (LinkAssociationState) Values

                                            Values returns all known values for LinkAssociationState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                            type LinkState

                                            type LinkState string
                                            const (
                                            	LinkStatePending   LinkState = "PENDING"
                                            	LinkStateAvailable LinkState = "AVAILABLE"
                                            	LinkStateDeleting  LinkState = "DELETING"
                                            	LinkStateUpdating  LinkState = "UPDATING"
                                            )

                                              Enum values for LinkState

                                              func (LinkState) Values

                                              func (LinkState) Values() []LinkState

                                                Values returns all known values for LinkState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                type Location

                                                type Location struct {
                                                
                                                	// The physical address.
                                                	Address *string
                                                
                                                	// The latitude.
                                                	Latitude *string
                                                
                                                	// The longitude.
                                                	Longitude *string
                                                }

                                                  Describes a location.

                                                  type ResourceNotFoundException

                                                  type ResourceNotFoundException struct {
                                                  	Message *string
                                                  
                                                  	ResourceId   *string
                                                  	ResourceType *string
                                                  }

                                                    The specified resource could not be found.

                                                    func (*ResourceNotFoundException) Error

                                                    func (e *ResourceNotFoundException) Error() string

                                                    func (*ResourceNotFoundException) ErrorCode

                                                    func (e *ResourceNotFoundException) ErrorCode() string

                                                    func (*ResourceNotFoundException) ErrorFault

                                                    func (*ResourceNotFoundException) ErrorMessage

                                                    func (e *ResourceNotFoundException) ErrorMessage() string

                                                    type ServiceQuotaExceededException

                                                    type ServiceQuotaExceededException struct {
                                                    	Message *string
                                                    
                                                    	ResourceId   *string
                                                    	ResourceType *string
                                                    	LimitCode    *string
                                                    	ServiceCode  *string
                                                    }

                                                      A service limit was exceeded.

                                                      func (*ServiceQuotaExceededException) Error

                                                      func (*ServiceQuotaExceededException) ErrorCode

                                                      func (e *ServiceQuotaExceededException) ErrorCode() string

                                                      func (*ServiceQuotaExceededException) ErrorFault

                                                      func (*ServiceQuotaExceededException) ErrorMessage

                                                      func (e *ServiceQuotaExceededException) ErrorMessage() string

                                                      type Site

                                                      type Site struct {
                                                      
                                                      	// The date and time that the site was created.
                                                      	CreatedAt *time.Time
                                                      
                                                      	// The description of the site.
                                                      	Description *string
                                                      
                                                      	// The ID of the global network.
                                                      	GlobalNetworkId *string
                                                      
                                                      	// The location of the site.
                                                      	Location *Location
                                                      
                                                      	// The Amazon Resource Name (ARN) of the site.
                                                      	SiteArn *string
                                                      
                                                      	// The ID of the site.
                                                      	SiteId *string
                                                      
                                                      	// The state of the site.
                                                      	State SiteState
                                                      
                                                      	// The tags for the site.
                                                      	Tags []Tag
                                                      }

                                                        Describes a site.

                                                        type SiteState

                                                        type SiteState string
                                                        const (
                                                        	SiteStatePending   SiteState = "PENDING"
                                                        	SiteStateAvailable SiteState = "AVAILABLE"
                                                        	SiteStateDeleting  SiteState = "DELETING"
                                                        	SiteStateUpdating  SiteState = "UPDATING"
                                                        )

                                                          Enum values for SiteState

                                                          func (SiteState) Values

                                                          func (SiteState) Values() []SiteState

                                                            Values returns all known values for SiteState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                            type Tag

                                                            type Tag struct {
                                                            
                                                            	// The tag key. Length Constraints: Maximum length of 128 characters.
                                                            	Key *string
                                                            
                                                            	// The tag value. Length Constraints: Maximum length of 256 characters.
                                                            	Value *string
                                                            }

                                                              Describes a tag.

                                                              type ThrottlingException

                                                              type ThrottlingException struct {
                                                              	Message *string
                                                              
                                                              	RetryAfterSeconds *int32
                                                              }

                                                                The request was denied due to request throttling.

                                                                func (*ThrottlingException) Error

                                                                func (e *ThrottlingException) Error() string

                                                                func (*ThrottlingException) ErrorCode

                                                                func (e *ThrottlingException) ErrorCode() string

                                                                func (*ThrottlingException) ErrorFault

                                                                func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

                                                                func (*ThrottlingException) ErrorMessage

                                                                func (e *ThrottlingException) ErrorMessage() string

                                                                type TransitGatewayConnectPeerAssociation

                                                                type TransitGatewayConnectPeerAssociation struct {
                                                                
                                                                	// The ID of the device.
                                                                	DeviceId *string
                                                                
                                                                	// The ID of the global network.
                                                                	GlobalNetworkId *string
                                                                
                                                                	// The ID of the link.
                                                                	LinkId *string
                                                                
                                                                	// The state of the association.
                                                                	State TransitGatewayConnectPeerAssociationState
                                                                
                                                                	// The Amazon Resource Name (ARN) of the transit gateway Connect peer.
                                                                	TransitGatewayConnectPeerArn *string
                                                                }

                                                                  Describes a transit gateway Connect peer association.

                                                                  type TransitGatewayConnectPeerAssociationState

                                                                  type TransitGatewayConnectPeerAssociationState string
                                                                  const (
                                                                  	TransitGatewayConnectPeerAssociationStatePending   TransitGatewayConnectPeerAssociationState = "PENDING"
                                                                  	TransitGatewayConnectPeerAssociationStateAvailable TransitGatewayConnectPeerAssociationState = "AVAILABLE"
                                                                  	TransitGatewayConnectPeerAssociationStateDeleting  TransitGatewayConnectPeerAssociationState = "DELETING"
                                                                  	TransitGatewayConnectPeerAssociationStateDeleted   TransitGatewayConnectPeerAssociationState = "DELETED"
                                                                  )

                                                                    Enum values for TransitGatewayConnectPeerAssociationState

                                                                    func (TransitGatewayConnectPeerAssociationState) Values

                                                                      Values returns all known values for TransitGatewayConnectPeerAssociationState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                                      type TransitGatewayRegistration

                                                                      type TransitGatewayRegistration struct {
                                                                      
                                                                      	// The ID of the global network.
                                                                      	GlobalNetworkId *string
                                                                      
                                                                      	// The state of the transit gateway registration.
                                                                      	State *TransitGatewayRegistrationStateReason
                                                                      
                                                                      	// The Amazon Resource Name (ARN) of the transit gateway.
                                                                      	TransitGatewayArn *string
                                                                      }

                                                                        Describes the registration of a transit gateway to a global network.

                                                                        type TransitGatewayRegistrationState

                                                                        type TransitGatewayRegistrationState string
                                                                        const (
                                                                        	TransitGatewayRegistrationStatePending   TransitGatewayRegistrationState = "PENDING"
                                                                        	TransitGatewayRegistrationStateAvailable TransitGatewayRegistrationState = "AVAILABLE"
                                                                        	TransitGatewayRegistrationStateDeleting  TransitGatewayRegistrationState = "DELETING"
                                                                        	TransitGatewayRegistrationStateDeleted   TransitGatewayRegistrationState = "DELETED"
                                                                        	TransitGatewayRegistrationStateFailed    TransitGatewayRegistrationState = "FAILED"
                                                                        )

                                                                          Enum values for TransitGatewayRegistrationState

                                                                          func (TransitGatewayRegistrationState) Values

                                                                            Values returns all known values for TransitGatewayRegistrationState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                                            type TransitGatewayRegistrationStateReason

                                                                            type TransitGatewayRegistrationStateReason struct {
                                                                            
                                                                            	// The code for the state reason.
                                                                            	Code TransitGatewayRegistrationState
                                                                            
                                                                            	// The message for the state reason.
                                                                            	Message *string
                                                                            }

                                                                              Describes the status of a transit gateway registration.

                                                                              type ValidationException

                                                                              type ValidationException struct {
                                                                              	Message *string
                                                                              
                                                                              	Reason ValidationExceptionReason
                                                                              	Fields []ValidationExceptionField
                                                                              }

                                                                                The input fails to satisfy the constraints.

                                                                                func (*ValidationException) Error

                                                                                func (e *ValidationException) Error() string

                                                                                func (*ValidationException) ErrorCode

                                                                                func (e *ValidationException) ErrorCode() string

                                                                                func (*ValidationException) ErrorFault

                                                                                func (e *ValidationException) ErrorFault() smithy.ErrorFault

                                                                                func (*ValidationException) ErrorMessage

                                                                                func (e *ValidationException) ErrorMessage() string

                                                                                type ValidationExceptionField

                                                                                type ValidationExceptionField struct {
                                                                                
                                                                                	// The message for the field.
                                                                                	//
                                                                                	// This member is required.
                                                                                	Message *string
                                                                                
                                                                                	// The name of the field.
                                                                                	//
                                                                                	// This member is required.
                                                                                	Name *string
                                                                                }

                                                                                  Describes a validation exception for a field.

                                                                                  type ValidationExceptionReason

                                                                                  type ValidationExceptionReason string
                                                                                  const (
                                                                                  	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UnknownOperation"
                                                                                  	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CannotParse"
                                                                                  	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FieldValidationFailed"
                                                                                  	ValidationExceptionReasonOther                 ValidationExceptionReason = "Other"
                                                                                  )

                                                                                    Enum values for ValidationExceptionReason

                                                                                    func (ValidationExceptionReason) Values

                                                                                      Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.