securityir

package module
v1.4.0 Latest Latest
Warning

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

 Go to latest Published: Jul 28, 2025 License: Apache-2.0 Imports: 45 Imported by: 2

Documentation

Overview

Package securityir provides the API client, operations, and parameter types for Security Incident Response.

This guide provides documents the action and response elements for customer use of the service.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-05-10"
View Source 
const ServiceID = "Security IR"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchGetMemberAccountDetailsInput 

type BatchGetMemberAccountDetailsInput struct {

	// Optional element to query the membership relationship status to a provided list
	// of account IDs.
	//
	// This member is required.
	AccountIds []string

	// Required element used in combination with BatchGetMemberAccountDetails to
	// identify the membership ID to query.
	//
	// This member is required.
	MembershipId *string
	// contains filtered or unexported fields
}

type BatchGetMemberAccountDetailsOutput 

type BatchGetMemberAccountDetailsOutput struct {

	// The response element providing errors messages for requests to
	// GetMembershipAccountDetails.
	Errors []types.GetMembershipAccountDetailError

	// The response element providing responses for requests to
	// GetMembershipAccountDetails.
	Items []types.GetMembershipAccountDetailItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelMembershipInput 

type CancelMembershipInput struct {

	// Required element used in combination with CancelMembershipRequest to identify
	// the membership ID to cancel.
	//
	// This member is required.
	MembershipId *string
	// contains filtered or unexported fields
}

type CancelMembershipOutput 

type CancelMembershipOutput struct {

	// The response element providing responses for requests to
	// CancelMembershipRequest.
	//
	// This member is required.
	MembershipId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Security Incident Response.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchGetMemberAccountDetails 

func (c *Client) BatchGetMemberAccountDetails(ctx context.Context, params *BatchGetMemberAccountDetailsInput, optFns ...func(*Options)) (*BatchGetMemberAccountDetailsOutput, error)

Grants permission to view an existing membership.

func (*Client) CancelMembership 

func (c *Client) CancelMembership(ctx context.Context, params *CancelMembershipInput, optFns ...func(*Options)) (*CancelMembershipOutput, error)

Grants permissions to cancel an existing membership.

func (*Client) CloseCase 

func (c *Client) CloseCase(ctx context.Context, params *CloseCaseInput, optFns ...func(*Options)) (*CloseCaseOutput, error)

Grants permission to close an existing case.

func (*Client) CreateCase 

func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns ...func(*Options)) (*CreateCaseOutput, error)

Grants permission to create a new case.

func (*Client) CreateCaseComment 

func (c *Client) CreateCaseComment(ctx context.Context, params *CreateCaseCommentInput, optFns ...func(*Options)) (*CreateCaseCommentOutput, error)

Grants permission to add a comment to an existing case.

func (*Client) CreateMembership 

func (c *Client) CreateMembership(ctx context.Context, params *CreateMembershipInput, optFns ...func(*Options)) (*CreateMembershipOutput, error)

Grants permissions to create a new membership.

func (*Client) GetCase 

func (c *Client) GetCase(ctx context.Context, params *GetCaseInput, optFns ...func(*Options)) (*GetCaseOutput, error)

Grant permission to view a designated case.

func (*Client) GetCaseAttachmentDownloadUrl 

func (c *Client) GetCaseAttachmentDownloadUrl(ctx context.Context, params *GetCaseAttachmentDownloadUrlInput, optFns ...func(*Options)) (*GetCaseAttachmentDownloadUrlOutput, error)

Grants permission to obtain an Amazon S3 presigned URL to download an attachment.

func (*Client) GetCaseAttachmentUploadUrl 

func (c *Client) GetCaseAttachmentUploadUrl(ctx context.Context, params *GetCaseAttachmentUploadUrlInput, optFns ...func(*Options)) (*GetCaseAttachmentUploadUrlOutput, error)

Grants permission to upload an attachment to a case.

func (*Client) GetMembership 

func (c *Client) GetMembership(ctx context.Context, params *GetMembershipInput, optFns ...func(*Options)) (*GetMembershipOutput, error)

Grants permission to get details of a designated service membership.

func (*Client) ListCaseEdits 

func (c *Client) ListCaseEdits(ctx context.Context, params *ListCaseEditsInput, optFns ...func(*Options)) (*ListCaseEditsOutput, error)

Grants permissions to view the aidt log for edits made to a designated case.

func (*Client) ListCases 

func (c *Client) ListCases(ctx context.Context, params *ListCasesInput, optFns ...func(*Options)) (*ListCasesOutput, error)

Grants permission to list all cases the requester has access to.

func (*Client) ListComments 

func (c *Client) ListComments(ctx context.Context, params *ListCommentsInput, optFns ...func(*Options)) (*ListCommentsOutput, error)

Grants permissions to list and view comments for a designated case.

func (*Client) ListMemberships 

func (c *Client) ListMemberships(ctx context.Context, params *ListMembershipsInput, optFns ...func(*Options)) (*ListMembershipsOutput, error)

Grants permission to query the memberships a principal has access to.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Grants permission to view currently configured tags on a resource.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Grants permission to add a tag(s) to a designated resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Grants permission to remove a tag(s) from a designate resource.

func (*Client) UpdateCase 

func (c *Client) UpdateCase(ctx context.Context, params *UpdateCaseInput, optFns ...func(*Options)) (*UpdateCaseOutput, error)

Grants permission to update an existing case.

func (*Client) UpdateCaseComment 

func (c *Client) UpdateCaseComment(ctx context.Context, params *UpdateCaseCommentInput, optFns ...func(*Options)) (*UpdateCaseCommentOutput, error)

Grants permission to update an existing case comment.

func (*Client) UpdateCaseStatus 

func (c *Client) UpdateCaseStatus(ctx context.Context, params *UpdateCaseStatusInput, optFns ...func(*Options)) (*UpdateCaseStatusOutput, error)

Grants permission to update the status for a designated cases. Options include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed .

func (*Client) UpdateMembership 

func (c *Client) UpdateMembership(ctx context.Context, params *UpdateMembershipInput, optFns ...func(*Options)) (*UpdateMembershipOutput, error)

Grants access to UpdateMembership to change membership configuration.

func (*Client) UpdateResolverType 

func (c *Client) UpdateResolverType(ctx context.Context, params *UpdateResolverTypeInput, optFns ...func(*Options)) (*UpdateResolverTypeOutput, error)

Grants permission to update the resolver type for a case.

This is a one-way action and cannot be reversed.

Options include self-supported > AWS-supported.

type CloseCaseInput 

type CloseCaseInput struct {

	// Required element used in combination with CloseCase to identify the case ID to
	// close.
	//
	// This member is required.
	CaseId *string
	// contains filtered or unexported fields
}

type CloseCaseOutput 

type CloseCaseOutput struct {

	// A response element providing responses for requests to CloseCase. This element
	// responds with the case status following the action.
	CaseStatus types.CaseStatus

	// A response element providing responses for requests to CloseCase. This element
	// responds with the case closure date following the action.
	ClosedDate *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCaseCommentInput 

type CreateCaseCommentInput struct {

	// Required element used in combination with CreateCaseComment to add content for
	// the new comment.
	//
	// This member is required.
	Body *string

	// Required element used in combination with CreateCaseComment to specify a case
	// ID.
	//
	// This member is required.
	CaseId *string

	// An optional element used in combination with CreateCaseComment.
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateCaseCommentOutput 

type CreateCaseCommentOutput struct {

	// Response element indicating the new comment ID.
	//
	// This member is required.
	CommentId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCaseInput 

type CreateCaseInput struct {

	// Required element used in combination with CreateCase to provide a description
	// for the new case.
	//
	// This member is required.
	Description *string

	// Required element used in combination with CreateCase to provide an engagement
	// type for the new cases. Available engagement types include Security Incident |
	// Investigation
	//
	// This member is required.
	EngagementType types.EngagementType

	// Required element used in combination with CreateCase to provide a list of
	// impacted accounts.
	//
	// This member is required.
	ImpactedAccounts []string

	// Required element used in combination with CreateCase to provide an initial
	// start date for the unauthorized activity.
	//
	// This member is required.
	ReportedIncidentStartDate *time.Time

	// Required element used in combination with CreateCase to identify the resolver
	// type. Available resolvers include self-supported | aws-supported.
	//
	// This member is required.
	ResolverType types.ResolverType

	// Required element used in combination with CreateCase to provide a title for the
	// new case.
	//
	// This member is required.
	Title *string

	// Required element used in combination with CreateCase to provide a list of
	// entities to receive notifications for case updates.
	//
	// This member is required.
	Watchers []types.Watcher

	// Required element used in combination with CreateCase.
	ClientToken *string

	// An optional element used in combination with CreateCase to provide a list of
	// impacted regions.
	ImpactedAwsRegions []types.ImpactedAwsRegion

	// An optional element used in combination with CreateCase to provide a list of
	// services impacted.
	ImpactedServices []string

	// An optional element used in combination with CreateCase to add customer
	// specified tags to a case.
	Tags map[string]string

	// An optional element used in combination with CreateCase to provide a list of
	// suspicious internet protocol addresses associated with unauthorized activity.
	ThreatActorIpAddresses []types.ThreatActorIp
	// contains filtered or unexported fields
}

type CreateCaseOutput 

type CreateCaseOutput struct {

	// A response element providing responses for requests to CreateCase. This element
	// responds with the case ID.
	//
	// This member is required.
	CaseId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMembershipInput 

type CreateMembershipInput struct {

	// Required element use in combination with CreateMembership to add customer
	// incident response team members and trusted partners to the membership.
	//
	// This member is required.
	IncidentResponseTeam []types.IncidentResponder

	// Required element use in combination with CreateMembership to create a name for
	// the membership.
	//
	// This member is required.
	MembershipName *string

	// An optional element used in combination with CreateMembership.
	ClientToken *string

	// Optional element to enable the monitoring and investigation opt-in features for
	// the service.
	OptInFeatures []types.OptInFeature

	// Optional element for customer configured tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateMembershipOutput 

type CreateMembershipOutput struct {

	// Response element for CreateMembership providing the newly created membership ID.
	//
	// This member is required.
	MembershipId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCaseAttachmentDownloadUrlInput 

type GetCaseAttachmentDownloadUrlInput struct {

	// Required element for GetCaseAttachmentDownloadUrl to identify the attachment ID
	// for downloading an attachment.
	//
	// This member is required.
	AttachmentId *string

	// Required element for GetCaseAttachmentDownloadUrl to identify the case ID for
	// downloading an attachment from.
	//
	// This member is required.
	CaseId *string
	// contains filtered or unexported fields
}

type GetCaseAttachmentDownloadUrlOutput 

type GetCaseAttachmentDownloadUrlOutput struct {

	// Response element providing the Amazon S3 presigned URL to download an
	// attachment.
	//
	// This member is required.
	AttachmentPresignedUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCaseAttachmentUploadUrlInput 

type GetCaseAttachmentUploadUrlInput struct {

	// Required element for GetCaseAttachmentUploadUrl to identify the case ID for
	// uploading an attachment to.
	//
	// This member is required.
	CaseId *string

	// Required element for GetCaseAttachmentUploadUrl to identify the size od the
	// file attachment.
	//
	// This member is required.
	ContentLength *int64

	// Required element for GetCaseAttachmentUploadUrl to identify the file name of
	// the attachment to upload.
	//
	// This member is required.
	FileName *string

	// Optional element for customer provided token.
	ClientToken *string
	// contains filtered or unexported fields
}

type GetCaseAttachmentUploadUrlOutput 

type GetCaseAttachmentUploadUrlOutput struct {

	// Response element providing the Amazon S3 presigned UTL to upload the attachment.
	//
	// This member is required.
	AttachmentPresignedUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCaseInput 

type GetCaseInput struct {

	// Required element for GetCase to identify the requested case ID.
	//
	// This member is required.
	CaseId *string
	// contains filtered or unexported fields
}

type GetCaseOutput 

type GetCaseOutput struct {

	// Response element for GetCase that provides the actual incident start date as
	// identified by data analysis during the investigation.
	ActualIncidentStartDate *time.Time

	// Response element for GetCase that provides the case ARN
	CaseArn *string

	// Response element for GetCase that provides a list of current case attachments.
	CaseAttachments []types.CaseAttachmentAttributes

	// Response element for GetCase that provides the case status. Options for
	// statuses include Submitted | Detection and Analysis | Eradication, Containment
	// and Recovery | Post-Incident Activities | Closed
	CaseStatus types.CaseStatus

	// Response element for GetCase that provides the date a specified case was closed.
	ClosedDate *time.Time

	// Response element for GetCase that provides the summary code for why a case was
	// closed.
	ClosureCode types.ClosureCode

	// Response element for GetCase that provides the date the case was created.
	CreatedDate *time.Time

	// Response element for GetCase that provides contents of the case description.
	Description *string

	// Response element for GetCase that provides the engagement type. Options for
	// engagement type include Active Security Event | Investigations
	EngagementType types.EngagementType

	// Response element for GetCase that provides a list of impacted accounts.
	ImpactedAccounts []string

	// Response element for GetCase that provides the impacted regions.
	ImpactedAwsRegions []types.ImpactedAwsRegion

	// Response element for GetCase that provides a list of impacted services.
	ImpactedServices []string

	// Response element for GetCase that provides the date a case was last modified.
	LastUpdatedDate *time.Time

	// Response element for GetCase that provides identifies the case is waiting on
	// customer input.
	PendingAction types.PendingAction

	// Response element for GetCase that provides the customer provided incident start
	// date.
	ReportedIncidentStartDate *time.Time

	// Response element for GetCase that provides the current resolver types. Options
	// include self-supported | AWS-supported .
	ResolverType types.ResolverType

	// Response element for GetCase that provides a list of suspicious IP addresses
	// associated with unauthorized activity.
	ThreatActorIpAddresses []types.ThreatActorIp

	// Response element for GetCase that provides the case title.
	Title *string

	// Response element for GetCase that provides a list of Watchers added to the case.
	Watchers []types.Watcher

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMembershipInput 

type GetMembershipInput struct {

	// Required element for GetMembership to identify the membership ID to query.
	//
	// This member is required.
	MembershipId *string
	// contains filtered or unexported fields
}

type GetMembershipOutput 

type GetMembershipOutput struct {

	// Response element for GetMembership that provides the queried membership ID.
	//
	// This member is required.
	MembershipId *string

	// Response element for GetMembership that provides the configured account for
	// managing the membership.
	AccountId *string

	// Response element for GetMembership that provides the configured membership
	// type. Options include Standalone | Organizations .
	CustomerType types.CustomerType

	// Response element for GetMembership that provides the configured membership
	// incident response team members.
	IncidentResponseTeam []types.IncidentResponder

	// Response element for GetMembership that provides the configured membership
	// activation timestamp.
	MembershipActivationTimestamp *time.Time

	// Response element for GetMembership that provides the membership ARN.
	MembershipArn *string

	// Response element for GetMembership that provides the configured membership name
	// deactivation timestamp.
	MembershipDeactivationTimestamp *time.Time

	// Response element for GetMembership that provides the configured membership name.
	MembershipName *string

	// Response element for GetMembership that provides the current membership status.
	MembershipStatus types.MembershipStatus

	// Response element for GetMembership that provides the number of accounts in the
	// membership.
	NumberOfAccountsCovered *int64

	// Response element for GetMembership that provides the if opt-in features have
	// been enabled.
	OptInFeatures []types.OptInFeature

	// Response element for GetMembership that provides the configured region for
	// managing the membership.
	Region types.AwsRegion

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListCaseEditsAPIClient 

type ListCaseEditsAPIClient interface {
	ListCaseEdits(context.Context, *ListCaseEditsInput, ...func(*Options)) (*ListCaseEditsOutput, error)
}

ListCaseEditsAPIClient is a client that implements the ListCaseEdits operation.

type ListCaseEditsInput 

type ListCaseEditsInput struct {

	// Required element used with ListCaseEdits to identify the case to query.
	//
	// This member is required.
	CaseId *string

	// Optional element to identify how many results to obtain. There is a maximum
	// value of 25.
	MaxResults *int32

	// Optional element for a customer provided token.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCaseEditsOutput 

type ListCaseEditsOutput struct {

	// Response element for ListCaseEdits that includes the action, eventtimestamp,
	// message, and principal for the response.
	Items []types.CaseEditItem

	// Optional element.
	NextToken *string

	// Response element for ListCaseEdits that identifies the total number of edits.
	Total *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCaseEditsPaginator 

type ListCaseEditsPaginator struct {
	// contains filtered or unexported fields
}

ListCaseEditsPaginator is a paginator for ListCaseEdits

func NewListCaseEditsPaginator 

func NewListCaseEditsPaginator(client ListCaseEditsAPIClient, params *ListCaseEditsInput, optFns ...func(*ListCaseEditsPaginatorOptions)) *ListCaseEditsPaginator

NewListCaseEditsPaginator returns a new ListCaseEditsPaginator

func (*ListCaseEditsPaginator) HasMorePages 

func (p *ListCaseEditsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCaseEditsPaginator) NextPage 

func (p *ListCaseEditsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCaseEditsOutput, error)

NextPage retrieves the next ListCaseEdits page.

type ListCaseEditsPaginatorOptions 

type ListCaseEditsPaginatorOptions struct {
	// Optional element to identify how many results to obtain. There is a maximum
	// value of 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCaseEditsPaginatorOptions is the paginator options for ListCaseEdits

type ListCasesAPIClient 

type ListCasesAPIClient interface {
	ListCases(context.Context, *ListCasesInput, ...func(*Options)) (*ListCasesOutput, error)
}

ListCasesAPIClient is a client that implements the ListCases operation.

type ListCasesInput 

type ListCasesInput struct {

	// Optional element for ListCases to limit the number of responses.
	MaxResults *int32

	// Optional element.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCasesOutput 

type ListCasesOutput struct {

	// Response element for ListCases that includes caseARN, caseID, caseStatus,
	// closedDate, createdDate, engagementType, lastUpdatedDate, pendingAction,
	// resolverType, and title for each response.
	Items []types.ListCasesItem

	// Optional element.
	NextToken *string

	// Response element for ListCases providing the total number of responses.
	Total *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCasesPaginator 

type ListCasesPaginator struct {
	// contains filtered or unexported fields
}

ListCasesPaginator is a paginator for ListCases

func NewListCasesPaginator 

func NewListCasesPaginator(client ListCasesAPIClient, params *ListCasesInput, optFns ...func(*ListCasesPaginatorOptions)) *ListCasesPaginator

NewListCasesPaginator returns a new ListCasesPaginator

func (*ListCasesPaginator) HasMorePages 

func (p *ListCasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCasesPaginator) NextPage 

func (p *ListCasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCasesOutput, error)

NextPage retrieves the next ListCases page.

type ListCasesPaginatorOptions 

type ListCasesPaginatorOptions struct {
	// Optional element for ListCases to limit the number of responses.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCasesPaginatorOptions is the paginator options for ListCases

type ListCommentsAPIClient 

type ListCommentsAPIClient interface {
	ListComments(context.Context, *ListCommentsInput, ...func(*Options)) (*ListCommentsOutput, error)
}

ListCommentsAPIClient is a client that implements the ListComments operation.

type ListCommentsInput 

type ListCommentsInput struct {

	// Required element for ListComments to designate the case to query.
	//
	// This member is required.
	CaseId *string

	// Optional element for ListComments to limit the number of responses.
	MaxResults *int32

	// Optional element.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCommentsOutput 

type ListCommentsOutput struct {

	// Response element for ListComments providing the body, commentID, createDate,
	// creator, lastUpdatedBy and lastUpdatedDate for each response.
	Items []types.ListCommentsItem

	// Optional request elements.
	NextToken *string

	// Response element for ListComments identifying the number of responses.
	Total *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCommentsPaginator 

type ListCommentsPaginator struct {
	// contains filtered or unexported fields
}

ListCommentsPaginator is a paginator for ListComments

func NewListCommentsPaginator 

func NewListCommentsPaginator(client ListCommentsAPIClient, params *ListCommentsInput, optFns ...func(*ListCommentsPaginatorOptions)) *ListCommentsPaginator

NewListCommentsPaginator returns a new ListCommentsPaginator

func (*ListCommentsPaginator) HasMorePages 

func (p *ListCommentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCommentsPaginator) NextPage 

func (p *ListCommentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCommentsOutput, error)

NextPage retrieves the next ListComments page.

type ListCommentsPaginatorOptions 

type ListCommentsPaginatorOptions struct {
	// Optional element for ListComments to limit the number of responses.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCommentsPaginatorOptions is the paginator options for ListComments

type ListMembershipsAPIClient 

type ListMembershipsAPIClient interface {
	ListMemberships(context.Context, *ListMembershipsInput, ...func(*Options)) (*ListMembershipsOutput, error)
}

ListMembershipsAPIClient is a client that implements the ListMemberships operation.

type ListMembershipsInput 

type ListMembershipsInput struct {

	// Request element for ListMemberships to limit the number of responses.
	MaxResults *int32

	// Optional element.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMembershipsOutput 

type ListMembershipsOutput struct {

	// Request element for ListMemberships including the accountID, membershipARN,
	// membershipID, membershipStatus, and region for each response.
	Items []types.ListMembershipItem

	// Optional element.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMembershipsPaginator 

type ListMembershipsPaginator struct {
	// contains filtered or unexported fields
}

ListMembershipsPaginator is a paginator for ListMemberships

func NewListMembershipsPaginator 

func NewListMembershipsPaginator(client ListMembershipsAPIClient, params *ListMembershipsInput, optFns ...func(*ListMembershipsPaginatorOptions)) *ListMembershipsPaginator

NewListMembershipsPaginator returns a new ListMembershipsPaginator

func (*ListMembershipsPaginator) HasMorePages 

func (p *ListMembershipsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMembershipsPaginator) NextPage 

func (p *ListMembershipsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMembershipsOutput, error)

NextPage retrieves the next ListMemberships page.

type ListMembershipsPaginatorOptions 

type ListMembershipsPaginatorOptions struct {
	// Request element for ListMemberships to limit the number of responses.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMembershipsPaginatorOptions is the paginator options for ListMemberships

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// Required element for ListTagsForResource to provide the ARN to identify a
	// specific resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Response element for ListTagsForResource providing content for each configured
	// tag.
	//
	// This member is required.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput 

type TagResourceInput struct {

	// Required element for TagResource to identify the ARN for the resource to add a
	// tag to.
	//
	// This member is required.
	ResourceArn *string

	// Required element for ListTagsForResource to provide the content for a tag.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// Required element for UnTagResource to identify the ARN for the resource to
	// remove a tag from.
	//
	// This member is required.
	ResourceArn *string

	// Required element for UnTagResource to identify tag to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCaseCommentInput 

type UpdateCaseCommentInput struct {

	// Required element for UpdateCaseComment to identify the content for the comment
	// to be updated.
	//
	// This member is required.
	Body *string

	// Required element for UpdateCaseComment to identify the case ID containing the
	// comment to be updated.
	//
	// This member is required.
	CaseId *string

	// Required element for UpdateCaseComment to identify the case ID to be updated.
	//
	// This member is required.
	CommentId *string
	// contains filtered or unexported fields
}

type UpdateCaseCommentOutput 

type UpdateCaseCommentOutput struct {

	// Response element for UpdateCaseComment providing the updated comment ID.
	//
	// This member is required.
	CommentId *string

	// Response element for UpdateCaseComment providing the updated comment content.
	Body *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCaseInput 

type UpdateCaseInput struct {

	// Required element for UpdateCase to identify the case ID for updates.
	//
	// This member is required.
	CaseId *string

	// Optional element for UpdateCase to provide content for the incident start date
	// field.
	ActualIncidentStartDate *time.Time

	// Optional element for UpdateCase to provide content for the description field.
	Description *string

	// Optional element for UpdateCase to provide content for the engagement type
	// field. Available engagement types include Security Incident | Investigation .
	EngagementType types.EngagementType

	// Optional element for UpdateCase to provide content to add accounts impacted.
	ImpactedAccountsToAdd []string

	// Optional element for UpdateCase to provide content to add accounts impacted.
	ImpactedAccountsToDelete []string

	// Optional element for UpdateCase to provide content to add regions impacted.
	ImpactedAwsRegionsToAdd []types.ImpactedAwsRegion

	// Optional element for UpdateCase to provide content to remove regions impacted.
	ImpactedAwsRegionsToDelete []types.ImpactedAwsRegion

	// Optional element for UpdateCase to provide content to add services impacted.
	ImpactedServicesToAdd []string

	// Optional element for UpdateCase to provide content to remove services impacted.
	ImpactedServicesToDelete []string

	// Optional element for UpdateCase to provide content for the customer reported
	// incident start date field.
	ReportedIncidentStartDate *time.Time

	// Optional element for UpdateCase to provide content to add additional suspicious
	// IP addresses related to a case.
	ThreatActorIpAddressesToAdd []types.ThreatActorIp

	// Optional element for UpdateCase to provide content to remove suspicious IP
	// addresses from a case.
	ThreatActorIpAddressesToDelete []types.ThreatActorIp

	// Optional element for UpdateCase to provide content for the title field.
	Title *string

	// Optional element for UpdateCase to provide content to add additional watchers
	// to a case.
	WatchersToAdd []types.Watcher

	// Optional element for UpdateCase to provide content to remove existing watchers
	// from a case.
	WatchersToDelete []types.Watcher
	// contains filtered or unexported fields
}

type UpdateCaseOutput 

type UpdateCaseOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCaseStatusInput 

type UpdateCaseStatusInput struct {

	// Required element for UpdateCaseStatus to identify the case to update.
	//
	// This member is required.
	CaseId *string

	// Required element for UpdateCaseStatus to identify the status for a case.
	// Options include Submitted | Detection and Analysis | Containment, Eradication
	// and Recovery | Post-incident Activities .
	//
	// This member is required.
	CaseStatus types.SelfManagedCaseStatus
	// contains filtered or unexported fields
}

type UpdateCaseStatusOutput 

type UpdateCaseStatusOutput struct {

	// Response element for UpdateCaseStatus showing the newly configured status.
	CaseStatus types.SelfManagedCaseStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMembershipInput 

type UpdateMembershipInput struct {

	// Required element for UpdateMembership to identify the membership to update.
	//
	// This member is required.
	MembershipId *string

	// Optional element for UpdateMembership to update the membership name.
	IncidentResponseTeam []types.IncidentResponder

	// Optional element for UpdateMembership to update the membership name.
	MembershipName *string

	// Optional element for UpdateMembership to enable or disable opt-in features for
	// the service.
	OptInFeatures []types.OptInFeature
	// contains filtered or unexported fields
}

type UpdateMembershipOutput 

type UpdateMembershipOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateResolverTypeInput 

type UpdateResolverTypeInput struct {

	// Required element for UpdateResolverType to identify the case to update.
	//
	// This member is required.
	CaseId *string

	// Required element for UpdateResolverType to identify the new resolver.
	//
	// This member is required.
	ResolverType types.ResolverType
	// contains filtered or unexported fields
}

type UpdateResolverTypeOutput 

type UpdateResolverTypeOutput struct {

	// Response element for UpdateResolver identifying the case ID being updated.
	//
	// This member is required.
	CaseId *string

	// Response element for UpdateResolver identifying the current status of the case.
	CaseStatus types.CaseStatus

	// Response element for UpdateResolver identifying the current resolver of the
	// case.
	ResolverType types.ResolverType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.