api

package

Go to main page

Versions in this module

v0

v0.3.3

May 11, 2026

Changes in this version

+ func ResolveTLSEndpoint(region string) string

type AuditEvent

+ ErrorCode string

+ EventDetail string

+ EventNameDisplay string

+ EventSourceDisplay string

+ RelatedResources []AuditRelatedResource

+ RequestID string

+ UserName string

+ type AuditRelatedResource struct

+ IntegratedTrn string

+ ResourceID string

+ ResourceType string

+ ResourceTypeDisplay string

+ ServiceCode string

+ SourceType string

type Client

+ func (c *Client) DoSigned(ctx context.Context, req Request, out any) error

+ func (c *Client) ListSmsSubAccounts(ctx context.Context, pageNumber, pageSize int) (ListSmsSubAccountsResponse, error)

+ func (c *Client) LookupAuditEvents(ctx context.Context, region string, start, end int64, pageSize int, ...) (LookupEventsResponse, error)

type DescribeTLSProjectsResponse

+ Projects []TLSProject

+ Total int

+ func (r DescribeTLSProjectsResponse) ProjectItems() []TLSProject

type ListSmsSignResponse

+ func (r ListSmsSignResponse) Signs() []SMSSign

+ type ListSmsSubAccountsResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

type ListSmsTemplateResponse

+ func (r ListSmsTemplateResponse) Templates() []SMSTemplate

+ type LookupConditionForLookupEventsInput struct

+ LookupConditionKey *string

+ LookupConditionValue *string

+ type LookupEventsResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

type Request

+ Endpoint string

+ SignService string

type SMSSign

+ Content string

+ CreatedAt int64

+ ID string

+ ReasonText string

+ Source string

+ StatusCode int64

+ type SMSSubAccount struct

+ CreatedTime int64

+ Desc string

+ Status int

+ SubAccount string

+ SubAccountID string

+ SubAccountName string

type SMSTemplate

+ ChannelType string

+ ChannelTypeName string

+ CreatedAt int64

+ ID string

+ Name string

+ ReasonText string

+ StatusCode int64

+ TemplateIDLower string

+ Text string

+ Type string

v0.3.2

May 9, 2026

v0.3.1

May 6, 2026

Changes in this version

+ type AuditEvent struct

+ AccessKeyID string

+ EventID string

+ EventName string

+ EventSource string

+ EventTime string

+ Region string

+ ResourceName string

+ ResourceType string

+ SourceIPAddress string

+ Status string

+ UserIdentity string

type Client

+ func (c *Client) CreateAccessKey(ctx context.Context, region, userName string) (CreateAccessKeyResponse, error)

+ func (c *Client) CreateRDSDBAccount(ctx context.Context, service, region, instanceID, name, password string) (CreateRDSAccountResponse, error)

+ func (c *Client) DeleteAccessKey(ctx context.Context, region, userName, accessKeyID string) (DeleteAccessKeyResponse, error)

+ func (c *Client) DeleteRDSDBAccount(ctx context.Context, service, region, instanceID, name string) (DeleteRDSAccountResponse, error)

+ func (c *Client) DescribeAuditEvents(ctx context.Context, region string, start, end int64, pageSize int, ...) (DescribeEventsResponse, error)

+ func (c *Client) DescribeRDSDBAccounts(ctx context.Context, service, region, instanceID string) (DescribeRDSAccountsResponse, error)

+ func (c *Client) DescribeTLSProjects(ctx context.Context, region string, pageNumber, pageSize int) (DescribeTLSProjectsResponse, error)

+ func (c *Client) ListAccessKeys(ctx context.Context, region, userName string) (ListAccessKeysResponse, error)

+ func (c *Client) ListAttachedUserPolicies(ctx context.Context, region, userName string) (ListAttachedUserPoliciesResponse, error)

+ func (c *Client) ListSmsSigns(ctx context.Context, region string, pageNumber, pageSize int) (ListSmsSignResponse, error)

+ func (c *Client) ListSmsTemplates(ctx context.Context, region string, pageNumber, pageSize int) (ListSmsTemplateResponse, error)

+ type CreateAccessKeyResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type CreateRDSAccountInput struct

+ AccountName string

+ AccountPassword string

+ AccountType string

+ InstanceID string

+ type CreateRDSAccountResponse struct

+ ResponseMetadata ResponseMetadata

+ type DeleteAccessKeyResponse struct

+ ResponseMetadata ResponseMetadata

+ type DeleteRDSAccountInput struct

+ AccountName string

+ InstanceID string

+ type DeleteRDSAccountResponse struct

+ ResponseMetadata ResponseMetadata

+ type DescribeEventsResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DescribeRDSAccountsResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DescribeTLSProjectsResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type IAMAccessKey struct

+ AccessKeyID string

+ CreateDate string

+ Status string

+ type IAMAccessKeySecret struct

+ AccessKeyID string

+ CreateDate string

+ SecretAccessKey string

+ Status string

+ type IAMAttachedPolicy struct

+ AttachDate string

+ Description string

+ PolicyName string

+ PolicyTrn string

+ PolicyType string

+ type ListAccessKeysResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type ListAttachedUserPoliciesResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type ListSmsSignResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type ListSmsTemplateResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type RDSDBAccount struct

+ AccountName string

+ AccountPrivileges string

+ AccountStatus string

+ AccountType string

+ type SMSSign struct

+ CreateTime string

+ Reason string

+ Sign string

+ SignID string

+ SignType string

+ Status string

+ type SMSTemplate struct

+ Content string

+ CreateTime string

+ Reason string

+ Status string

+ TemplateID string

+ TemplateName string

+ TemplateType string

+ type TLSProject struct

+ CreateTime string

+ Description string

+ IamProjectID string

+ ProjectID string

+ ProjectName string

+ Region string

v0.3.0

Apr 29, 2026

v0.2.7

Apr 27, 2026

v0.2.6

Apr 23, 2026

v0.2.5

Apr 23, 2026

Changes in this version

+ const ServiceRDSMSSQL

+ const ServiceRDSMySQL

+ const ServiceRDSPostgreSQL

+ func IsAccessDenied(err error) bool

type Client

+ func (c *Client) DescribeRDSMySQLInstances(ctx context.Context, region string, pageNumber, pageSize int32) (DescribeRDSMySQLInstancesResponse, error)

+ func (c *Client) DescribeRDSPostgreSQLInstances(ctx context.Context, region string, pageNumber, pageSize int32) (DescribeRDSPostgreSQLInstancesResponse, error)

+ func (c *Client) DescribeRDSRegions(ctx context.Context, service, region string) (DescribeRDSRegionsResponse, error)

+ func (c *Client) DescribeRDSSQLServerInstances(ctx context.Context, region string, pageNumber, pageSize int32) (DescribeRDSSQLServerInstancesResponse, error)

+ func (c *Client) ListDNSRecords(ctx context.Context, zid int64, pageNumber, pageSize int32) (ListDNSRecordsResponse, error)

+ func (c *Client) ListDNSZones(ctx context.Context, pageNumber, pageSize int32) (ListDNSZonesResponse, error)

+ type DNSRecord struct

+ Enable *bool

+ FQDN string

+ Host string

+ Type string

+ Value string

+ type DNSZone struct

+ ZID int64

+ ZoneName string

+ type DescribeRDSMySQLInstancesResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DescribeRDSPostgreSQLInstancesResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DescribeRDSRegionsResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DescribeRDSSQLServerInstancesResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type ListDNSRecordsResponse struct

+ PageNumber int32

+ PageSize int32

+ Records []DNSRecord

+ TotalCount int32

+ type ListDNSZonesResponse struct

+ Total int32

+ Zones []DNSZone

+ type RDSAddressObject struct

+ Domain string

+ IPAddress string

+ NetworkType string

+ Port string

+ type RDSMySQLInstance struct

+ AddressObject []RDSAddressObject

+ DBEngineVersion string

+ InstanceID string

+ InstanceName string

+ InstanceStatus string

+ RegionID string

+ type RDSPostgreSQLInstance struct

+ AddressObject []RDSAddressObject

+ DBEngineVersion string

+ InstanceID string

+ InstanceName string

+ InstanceStatus string

+ RegionID string

+ type RDSRegion struct

+ RegionID string

+ RegionName string

+ type RDSSQLServerInstance struct

+ DBEngineVersion string

+ InstanceID string

+ InstanceName string

+ InstanceStatus string

+ NodeDetailInfo []RDSSQLServerNode

+ Port string

+ RegionID string

+ type RDSSQLServerNode struct

+ NodeIP string

+ NodeType string

v0.2.4

Apr 22, 2026

Changes in this version

+ type AttachUserPolicyResponse struct

+ ResponseMetadata ResponseMetadata

type Client

+ func (c *Client) AttachUserPolicy(ctx context.Context, region, userName, policyName, policyType string) (AttachUserPolicyResponse, error)

+ func (c *Client) CreateCommand(ctx context.Context, ...) (CreateCommandResponse, error)

+ func (c *Client) CreateLoginProfile(ctx context.Context, region, userName, password string) (CreateLoginProfileResponse, error)

+ func (c *Client) CreateUser(ctx context.Context, region, userName, displayName string) (CreateUserResponse, error)

+ func (c *Client) DeleteCommand(ctx context.Context, region, commandID string) (DeleteCommandResponse, error)

+ func (c *Client) DeleteLoginProfile(ctx context.Context, region, userName string) (DeleteLoginProfileResponse, error)

+ func (c *Client) DeleteUser(ctx context.Context, region, userName string) (DeleteUserResponse, error)

+ func (c *Client) DescribeCloudAssistantStatus(ctx context.Context, region string, instanceIDs []string, osType string, ...) (DescribeCloudAssistantStatusResponse, error)

+ func (c *Client) DescribeInvocationResults(ctx context.Context, region, invocationID, commandID, instanceID string, ...) (DescribeInvocationResultsResponse, error)

+ func (c *Client) DetachUserPolicy(ctx context.Context, region, userName, policyName, policyType string) (DetachUserPolicyResponse, error)

+ func (c *Client) InvokeCommand(ctx context.Context, region, commandID, invocationName string, ...) (InvokeCommandResponse, error)

+ type CreateCommandResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type CreateLoginProfileResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type CreateUserResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DeleteCommandResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DeleteLoginProfileResponse struct

+ ResponseMetadata ResponseMetadata

+ type DeleteUserResponse struct

+ ResponseMetadata ResponseMetadata

+ type DescribeCloudAssistantStatusResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DescribeInvocationResultsResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DetachUserPolicyResponse struct

+ ResponseMetadata ResponseMetadata

+ type ECSCloudAssistantInstance struct

+ ClientVersion string

+ HostName string

+ InstanceID string

+ InstanceName string

+ LastHeartbeatTime string

+ OSType string

+ OSVersion string

+ Status string

+ type ECSInvocationResult struct

+ CommandID string

+ ErrorCode string

+ ErrorInfo string

+ ErrorMessage string

+ InstanceID string

+ InvocationID string

+ InvocationResultStatus string

+ InvocationStatus string

+ Output string

+ func (r ECSInvocationResult) Message() string

+ func (r ECSInvocationResult) Status() string

type IAMLoginProfile

+ LoginAllowed bool

+ PasswordResetRequired bool

+ type InvokeCommandResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

v0.2.3

Apr 21, 2026

Changes in this version

+ const Algorithm

+ const DateFormat

+ const DefaultRegion

+ const DefaultTimeout

+ const HeaderAuthorization

+ const HeaderXContentSHA256

+ const HeaderXDate

+ const HeaderXSecurityToken

+ func DecodeError(statusCode int, body []byte) error

+ func ErrorCode(err error) string

+ func NewHTTPClient() *http.Client

+ func NewTransport() *http.Transport

+ func ResolveEndpoint(service, region, siteStack string) string

+ type APIError struct

+ Action string

+ Code string

+ HTTPStatus int

+ Message string

+ RequestID string

+ Service string

+ func (e *APIError) Error() string

+ type Client struct

+ func NewClient(cred auth.Credential, opts ...Option) *Client

+ func (c *Client) DescribeInstances(ctx context.Context, region string, maxResults int32, nextToken string) (DescribeInstancesResponse, error)

+ func (c *Client) DescribeRegions(ctx context.Context, region string, maxResults int32) (DescribeRegionsResponse, error)

+ func (c *Client) DoOpenAPI(ctx context.Context, req Request, out any) error

+ func (c *Client) GetLoginProfile(ctx context.Context, region, userName string) (GetLoginProfileResponse, error)

+ func (c *Client) ListProjects(ctx context.Context, region string) (ListProjectsResponse, error)

+ func (c *Client) ListUsers(ctx context.Context, region string, limit, offset int32) (ListUsersResponse, error)

+ func (c *Client) QueryBalanceAcct(ctx context.Context, region string) (QueryBalanceAcctResponse, error)

+ type DescribeInstancesResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type DescribeRegionsResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type ECSEipAddress struct

+ IPAddress string

+ type ECSInstance struct

+ EipAddress ECSEipAddress

+ Hostname string

+ InstanceID string

+ NetworkInterfaces []ECSNetworkInterface

+ OSType string

+ Status string

+ type ECSNetworkInterface struct

+ PrimaryIPAddress string

+ type ECSRegion struct

+ RegionID string

+ type ErrorBody struct

+ Code string

+ CodeN int

+ Message string

+ type GetLoginProfileResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type IAMLoginProfile struct

+ LastLoginDate string

+ UserName string

+ type IAMProject struct

+ AccountID int64

+ ProjectName string

+ type IAMUserMetadata struct

+ AccountID int64

+ CreateDate string

+ UserName string

+ type ListProjectsResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type ListUsersResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type Option func(*Client)

+ func WithBaseURL(rawURL string) Option

+ func WithClock(now func() time.Time) Option

+ func WithHTTPClient(hc *http.Client) Option

+ func WithRetryPolicy(p RetryPolicy) Option

+ func WithSiteStack(siteStack string) Option

+ type QueryBalanceAcctResponse struct

+ ResponseMetadata ResponseMetadata

+ Result struct{ ... }

+ type Request struct

+ Action string

+ Body []byte

+ Headers http.Header

+ Idempotent bool

+ Method string

+ Path string

+ Query url.Values

+ Region string

+ Service string

+ Version string

+ type ResponseMetadata struct

+ Error *ErrorBody

+ RequestID string

+ type RetryPolicy struct

+ BaseDelay time.Duration

+ MaxAttempts int

+ MaxDelay time.Duration

+ Sleep func(context.Context, time.Duration) error

+ func DefaultRetryPolicy() RetryPolicy

+ func (p RetryPolicy) Do(ctx context.Context, idempotent bool, fn func() (*http.Response, error)) (*http.Response, error)

+ type SignInput struct

+ AccessKey string

+ Body []byte

+ ContentType string

+ Headers http.Header

+ Host string

+ Method string

+ Path string

+ Query url.Values

+ Region string

+ SecretKey string

+ Service string

+ SessionToken string

+ Timestamp time.Time

+ type Signature struct

+ Authorization string

+ CanonicalRequest string

+ CredentialScope string

+ SignedHeaders string

+ StringToSign string

+ XContentSHA256 string

+ XDate string

+ func Sign(input SignInput) (Signature, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL