UpdateMembershipCommand

Grants access to UpdateMembership to change membership configuration.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SecurityIRClient, UpdateMembershipCommand } from "@aws-sdk/client-security-ir"; // ES Modules import
// const { SecurityIRClient, UpdateMembershipCommand } = require("@aws-sdk/client-security-ir"); // CommonJS import
const client = new SecurityIRClient(config);
const input = { // UpdateMembershipRequest
  membershipId: "STRING_VALUE", // required
  membershipName: "STRING_VALUE",
  incidentResponseTeam: [ // IncidentResponseTeam
    { // IncidentResponder
      name: "STRING_VALUE", // required
      jobTitle: "STRING_VALUE", // required
      email: "STRING_VALUE", // required
    },
  ],
  optInFeatures: [ // OptInFeatures
    { // OptInFeature
      featureName: "Triage", // required
      isEnabled: true || false, // required
    },
  ],
};
const command = new UpdateMembershipCommand(input);
const response = await client.send(command);
// {};

Example Usage

 Loading code editorLoading code editor

UpdateMembershipCommand Input

See UpdateMembershipCommandInput for more details

Parameter
Type
Description
membershipId
Required
string | undefined

Required element for UpdateMembership to identify the membership to update.

incidentResponseTeam
IncidentResponder[] | undefined

Optional element for UpdateMembership to update the membership name.

membershipName
string | undefined

Optional element for UpdateMembership to update the membership name.

optInFeatures
OptInFeature[] | undefined

Optional element for UpdateMembership to enable or disable opt-in features for the service.

UpdateMembershipCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client
<p/>
ConflictException
client
<p/>
InternalServerException
server
<p/>
InvalidTokenException
client
<p/>
ResourceNotFoundException
client
<p/>
SecurityIncidentResponseNotActiveException
client
<p/>
ServiceQuotaExceededException
client
<p/>
ThrottlingException
client
<p/>
ValidationException
client
<p/>
SecurityIRServiceException
Base exception class for all service exceptions from SecurityIR service.